azure.mgmt.web.v2015_08_01.models module

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

Bases: msrest.serialization.Model

Information about the formal API definition for the app.

Parameters

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

class azure.mgmt.web.v2015_08_01.models.AppServiceCertificate(*, key_vault_id: str = None, key_vault_secret_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters

  • key_vault_id (str) – Key Vault resource Id.

  • key_vault_secret_name (str) – Key Vault secret name.

Variables

provisioning_state (str or KeyVaultSecretStatus) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘ExternalPrivateKey’, ‘Unknown’

class azure.mgmt.web.v2015_08_01.models.AppServiceCertificateOrder(*, location: str, product_type, kind: str = None, tags=None, certificates=None, distinguished_name: str = None, validity_in_years: int = 1, key_size: int = 2048, auto_renew: bool = True, csr: str = None, **kwargs)[source]

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

SSL certificate purchase order.

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • domain_verification_token (str) – Domain verification token.

  • provisioning_state (str or ProvisioningState) – Status of certificate order. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

  • status (str or CertificateOrderStatus) – Current order status. Possible values include: ‘Pendingissuance’, ‘Issued’, ‘Revoked’, ‘Canceled’, ‘Denied’, ‘Pendingrevocation’, ‘PendingRekey’, ‘Unused’, ‘Expired’, ‘NotSubmitted’

  • signed_certificate (CertificateDetails) – Signed certificate.

  • intermediate (CertificateDetails) – Intermediate certificate.

  • root (CertificateDetails) – Root certificate.

  • serial_number (str) – Current serial number of the certificate.

  • last_certificate_issuance_time (datetime) – Certificate last issuance time.

  • expiration_time (datetime) – Certificate expiration time.

  • is_private_key_external (bool) – <code>true</code> if private key is external; otherwise, <code>false</code>.

  • app_service_certificate_not_renewable_reasons (list[str]) – Reasons why App Service Certificate is not renewable at the current moment.

  • next_auto_renewal_time_stamp (datetime) – Time stamp when the certificate would be auto renewed next

Parameters

  • kind (str) – Kind of resource.

  • location (str) – Required. Resource Location.

  • tags (dict[str, str]) – Resource tags.

  • certificates (dict[str, AppServiceCertificate]) – State of the Key Vault secret.

  • distinguished_name (str) – Certificate distinguished name.

  • validity_in_years (int) – Duration in years (must be between 1 and 3). Default value: 1 .

  • key_size (int) – Certificate key size. Default value: 2048 .

  • product_type (str or CertificateProductType) – Required. Certificate product type. Possible values include: ‘StandardDomainValidatedSsl’, ‘StandardDomainValidatedWildCardSsl’

  • auto_renew (bool) – <code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>. Default value: True .

  • csr (str) – Last CSR that was created for this order.

class azure.mgmt.web.v2015_08_01.models.AppServiceCertificateOrderPatchResource(*, product_type, kind: str = None, certificates=None, distinguished_name: str = None, validity_in_years: int = 1, key_size: int = 2048, auto_renew: bool = True, csr: str = None, **kwargs)[source]

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

ARM resource for a certificate order that is purchased through Azure.

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • domain_verification_token (str) – Domain verification token.

  • provisioning_state (str or ProvisioningState) – Status of certificate order. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

  • status (str or CertificateOrderStatus) – Current order status. Possible values include: ‘Pendingissuance’, ‘Issued’, ‘Revoked’, ‘Canceled’, ‘Denied’, ‘Pendingrevocation’, ‘PendingRekey’, ‘Unused’, ‘Expired’, ‘NotSubmitted’

  • signed_certificate (CertificateDetails) – Signed certificate.

  • intermediate (CertificateDetails) – Intermediate certificate.

  • root (CertificateDetails) – Root certificate.

  • serial_number (str) – Current serial number of the certificate.

  • last_certificate_issuance_time (datetime) – Certificate last issuance time.

  • expiration_time (datetime) – Certificate expiration time.

  • is_private_key_external (bool) – <code>true</code> if private key is external; otherwise, <code>false</code>.

  • app_service_certificate_not_renewable_reasons (list[str]) – Reasons why App Service Certificate is not renewable at the current moment.

  • next_auto_renewal_time_stamp (datetime) – Time stamp when the certificate would be auto renewed next

Parameters

  • kind (str) – Kind of resource.

  • certificates (dict[str, AppServiceCertificate]) – State of the Key Vault secret.

  • distinguished_name (str) – Certificate distinguished name.

  • validity_in_years (int) – Duration in years (must be between 1 and 3). Default value: 1 .

  • key_size (int) – Certificate key size. Default value: 2048 .

  • product_type (str or CertificateProductType) – Required. Certificate product type. Possible values include: ‘StandardDomainValidatedSsl’, ‘StandardDomainValidatedWildCardSsl’

  • auto_renew (bool) – <code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>. Default value: True .

  • csr (str) – Last CSR that was created for this order.

class azure.mgmt.web.v2015_08_01.models.AppServiceCertificatePatchResource(*, kind: str = None, key_vault_id: str = None, key_vault_secret_name: str = None, **kwargs)[source]

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • provisioning_state (str or KeyVaultSecretStatus) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘ExternalPrivateKey’, ‘Unknown’

Parameters

  • kind (str) – Kind of resource.

  • key_vault_id (str) – Key Vault resource Id.

  • key_vault_secret_name (str) – Key Vault secret name.

class azure.mgmt.web.v2015_08_01.models.AppServiceCertificateResource(*, location: str, kind: str = None, tags=None, key_vault_id: str = None, key_vault_secret_name: str = None, **kwargs)[source]

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

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • provisioning_state (str or KeyVaultSecretStatus) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘ExternalPrivateKey’, ‘Unknown’

Parameters

  • kind (str) – Kind of resource.

  • location (str) – Required. Resource Location.

  • tags (dict[str, str]) – Resource tags.

  • key_vault_id (str) – Key Vault resource Id.

  • key_vault_secret_name (str) – Key Vault secret name.

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

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

App Service plan.

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • status (str or StatusOptions) – App Service plan status. Possible values include: ‘Ready’, ‘Pending’, ‘Creating’

  • subscription (str) – App Service plan subscription.

  • maximum_number_of_workers (int) – Maximum number of instances that can be assigned to this App Service plan.

  • geo_region (str) – Geographical location for the App Service plan.

  • number_of_sites (int) – Number of apps assigned to this App Service plan.

  • resource_group (str) – Resource group of the App Service plan.

  • provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

Parameters

  • kind (str) – Kind of resource.

  • location (str) – Required. Resource Location.

  • tags (dict[str, str]) – Resource tags.

  • app_service_plan_name (str) – Required. Name for the App Service plan.

  • worker_tier_name (str) – Target worker tier assigned to the App Service plan.

  • admin_site_name (str) – App Service plan administration site.

  • hosting_environment_profile (HostingEnvironmentProfile) – Specification for the App Service Environment to use for the App Service plan.

  • per_site_scaling (bool) – If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. Default value: False .

  • is_spot (bool) – If <code>true</code>, this App Service Plan owns spot instances.

  • spot_expiration_time (datetime) – The time when the server farm expires. Valid only if it is a spot server farm.

  • reserved (bool) – If Linux app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .

  • target_worker_count (int) – Scaling worker count.

  • target_worker_size_id (int) – Scaling worker size ID.

  • sku (SkuDescription) –

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

Bases: msrest.serialization.Model

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

Parameters

  • action_type (str or AutoHealActionType) – Predefined action to be taken. Possible values include: ‘Recycle’, ‘LogEvent’, ‘CustomAction’

  • custom_action (AutoHealCustomAction) – Custom action to be taken.

  • min_process_execution_time (str) – Minimum time the process must execute before taking the action

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

Bases: msrest.serialization.Model

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

Parameters

  • exe (str) – Executable to be run.

  • parameters (str) – Parameters for the executable.

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

Bases: msrest.serialization.Model

Rules that can be defined for auto-heal.

Parameters

  • triggers (AutoHealTriggers) – Conditions that describe when to execute the auto-heal actions.

  • actions (AutoHealActions) – Actions to be executed when a rule is triggered.

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

Bases: msrest.serialization.Model

Triggers for auto-heal.

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

Bases: msrest.serialization.Model

Describes the capabilities/features allowed for a specific SKU.

Parameters

  • name (str) – Name of the SKU capability.

  • value (str) – Value of the SKU capability.

  • reason (str) – Reason of the SKU capability.

class azure.mgmt.web.v2015_08_01.models.CertificateDetails(**kwargs)[source]

Bases: msrest.serialization.Model

SSL certificate details.

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

Variables

  • version (int) – Certificate Version.

  • serial_number (str) – Certificate Serial Number.

  • thumbprint (str) – Certificate Thumbprint.

  • subject (str) – Certificate Subject.

  • not_before (datetime) – Date Certificate is valid from.

  • not_after (datetime) – Date Certificate is valid to.

  • signature_algorithm (str) – Certificate Signature algorithm.

  • issuer (str) – Certificate Issuer.

  • raw_data (str) – Raw certificate data.

class azure.mgmt.web.v2015_08_01.models.CertificateEmail(*, kind: str = None, email_id: str = None, time_stamp=None, **kwargs)[source]

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

SSL certificate email.

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • email_id (str) – Email id.

  • time_stamp (datetime) – Time stamp.

class azure.mgmt.web.v2015_08_01.models.CertificateOrderAction(*, kind: str = None, certificate_order_action_type=None, created_at=None, **kwargs)[source]

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

Certificate order action.

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • certificate_order_action_type (str or CertificateOrderActionType) – Action type. Possible values include: ‘CertificateIssued’, ‘CertificateOrderCanceled’, ‘CertificateOrderCreated’, ‘CertificateRevoked’, ‘DomainValidationComplete’, ‘FraudDetected’, ‘OrgNameChange’, ‘OrgValidationComplete’, ‘SanDrop’, ‘FraudCleared’, ‘CertificateExpired’, ‘CertificateExpirationWarning’, ‘FraudDocumentationRequired’, ‘Unknown’

  • created_at (datetime) – Time at which the certificate action was performed.

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

Bases: msrest.serialization.Model

Information needed for cloning operation.

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

Parameters

  • correlation_id (str) – Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

  • overwrite (bool) – <code>true</code> to overwrite destination app; otherwise, <code>false</code>.

  • clone_custom_host_names (bool) – <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>.

  • clone_source_control (bool) – <code>true</code> to clone source control from source app; otherwise, <code>false</code>.

  • source_web_app_id (str) – Required. ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

  • hosting_environment (str) – App Service Environment.

  • app_settings_overrides (dict[str, str]) – Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.

  • configure_load_balancing (bool) – <code>true</code> to configure load balancing for source and destination app.

  • traffic_manager_profile_id (str) – ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.

  • traffic_manager_profile_name (str) – Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

  • ignore_quotas (bool) – <code>true</code> if quotas should be ignored; otherwise, <code>false</code>.

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

Bases: msrest.serialization.Model

Database connection string information.

Parameters

  • name (str) – Name of connection string.

  • connection_string (str) – Connection string value.

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

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

Bases: msrest.serialization.Model

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

Parameters

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

class azure.mgmt.web.v2015_08_01.models.CsmOperationDescription(*, name: str = None, display=None, origin: str = None, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Description of an operation available for Microsoft.Web resource provider.

Parameters
class azure.mgmt.web.v2015_08_01.models.CsmOperationDescriptionProperties(*, service_specification=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties available for a Microsoft.Web resource provider operation.

Parameters

service_specification (ServiceSpecification) –

class azure.mgmt.web.v2015_08_01.models.CsmOperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Meta data about operation used for display in portal.

Parameters

  • provider (str) –

  • resource (str) –

  • operation (str) –

  • description (str) –

class azure.mgmt.web.v2015_08_01.models.Dimension(*, name: str = None, display_name: str = None, internal_name: str = None, to_be_exported_for_shoebox: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, where instance name is dimension of the metric HTTP request.

Parameters

  • name (str) –

  • display_name (str) –

  • internal_name (str) –

  • to_be_exported_for_shoebox (bool) –

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

Bases: msrest.serialization.Model

Routing rules in production experiments.

Parameters

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

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

Bases: msrest.serialization.Model

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

Parameters

  • extension (str) – Requests with this extension will be handled using the specified FastCGI application.

  • script_processor (str) – The absolute path to the FastCGI application.

  • arguments (str) – Command-line arguments to be passed to the script processor.

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

Bases: msrest.serialization.Model

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

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

Parameters

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

Variables

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

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

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

Bases: msrest.serialization.Model

SSL-enabled hostname.

Parameters

  • name (str) – Hostname.

  • ssl_state (str or SslState) – SSL type. Possible values include: ‘Disabled’, ‘SniEnabled’, ‘IpBasedEnabled’

  • virtual_ip (str) – Virtual IP address assigned to the hostname if IP based SSL is enabled.

  • thumbprint (str) – SSL certificate thumbprint.

  • to_update (bool) – Set to <code>true</code> to update existing hostname.

  • host_type (str or HostType) – Indicates whether the hostname is a standard or repository hostname. Possible values include: ‘Standard’, ‘Repository’

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

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • service_bus_namespace (str) – The name of the Service Bus namespace.

  • relay_name (str) – The name of the Service Bus relay.

  • relay_arm_uri (str) – The ARM URI to the Service Bus relay.

  • hostname (str) – The hostname of the endpoint.

  • port (int) – The port of the endpoint.

  • send_key_name (str) – The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.

  • send_key_value (str) – The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.

  • service_bus_suffix (str) – The suffix for the service bus endpoint. By default this is .servicebus.windows.net

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

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • send_key_name (str) – The name of the send key.

  • send_key_value (str) – The value of the send key.

Parameters

kind (str) – Kind of resource.

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

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

A domain specific resource identifier.

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • identifier_id (str) – String representation of the identity.

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

Bases: msrest.serialization.Model

IP security restriction on an app.

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

Parameters

  • ip_address (str) – Required. IP address the security restriction is valid for.

  • subnet_mask (str) – Subnet mask for the range of IP addresses the restriction is valid for.

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

Bases: msrest.serialization.Model

Managed service identity.

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

Parameters

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

Variables

  • tenant_id (str) – Tenant of managed service identity.

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

class azure.mgmt.web.v2015_08_01.models.MetricAvailability(*, time_grain: str = None, blob_duration: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Retention policy of a resource metric.

Parameters

  • time_grain (str) –

  • blob_duration (str) –

class azure.mgmt.web.v2015_08_01.models.MetricSpecification(*, name: str = None, display_name: str = None, display_description: str = None, unit: str = None, aggregation_type: str = None, supports_instance_level_aggregation: bool = None, enable_regional_mdm_account: bool = None, source_mdm_account: str = None, source_mdm_namespace: str = None, metric_filter_pattern: str = None, fill_gap_with_zero: bool = None, is_internal: bool = None, dimensions=None, category: str = None, availabilities=None, **kwargs)[source]

Bases: msrest.serialization.Model

Definition of a single resource metric.

Parameters

  • name (str) –

  • display_name (str) –

  • display_description (str) –

  • unit (str) –

  • aggregation_type (str) –

  • supports_instance_level_aggregation (bool) –

  • enable_regional_mdm_account (bool) –

  • source_mdm_account (str) –

  • source_mdm_namespace (str) –

  • metric_filter_pattern (str) –

  • fill_gap_with_zero (bool) –

  • is_internal (bool) –

  • dimensions (list[Dimension]) –

  • category (str) –

  • availabilities (list[MetricAvailability]) –

class azure.mgmt.web.v2015_08_01.models.NameIdentifier(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Identifies an object.

Parameters

name (str) – Name of the object.

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

Bases: msrest.serialization.Model

Name value pair.

Parameters

  • name (str) – Pair name.

  • value (str) – Pair value.

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

Bases: msrest.serialization.Model

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

kind (str) – Kind of resource.

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

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

Push settings for the App.

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • is_push_enabled (bool) – Required. Gets or sets a flag indicating whether the Push endpoint is enabled.

  • tag_whitelist_json (str) – Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.

  • tags_requiring_auth (str) – Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: ‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-‘. Validation should be performed at the PushRequestHandler.

  • dynamic_tags_json (str) – Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

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

Bases: msrest.serialization.Model

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

Parameters

  • action_host_name (str) – Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

  • reroute_percentage (float) – Percentage of the traffic which will be redirected to <code>ActionHostName</code>.

  • change_step (float) – In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.

  • change_interval_in_minutes (int) – Specifies interval in minutes to reevaluate ReroutePercentage.

  • min_reroute_percentage (float) – Specifies lower boundary above which ReroutePercentage will stay.

  • max_reroute_percentage (float) – Specifies upper boundary below which ReroutePercentage will stay.

  • change_decision_callback_url (str) – Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

  • name (str) – Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

class azure.mgmt.web.v2015_08_01.models.ReissueCertificateOrderRequest(*, kind: str = None, key_size: int = None, delay_existing_revoke_in_hours: int = None, csr: str = None, is_private_key_external: bool = None, **kwargs)[source]

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

Class representing certificate reissue request.

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • key_size (int) – Certificate Key Size.

  • delay_existing_revoke_in_hours (int) – Delay in hours to revoke existing certificate after the new certificate is issued.

  • csr (str) – Csr to be used for re-key operation.

  • is_private_key_external (bool) – Should we change the ASC type (from managed private key to external private key and vice versa).

class azure.mgmt.web.v2015_08_01.models.RenewCertificateOrderRequest(*, kind: str = None, key_size: int = None, csr: str = None, is_private_key_external: bool = None, **kwargs)[source]

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

Class representing certificate renew request.

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • key_size (int) – Certificate Key Size.

  • csr (str) – Csr to be used for re-key operation.

  • is_private_key_external (bool) – Should we change the ASC type (from managed private key to external private key and vice versa).

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

Bases: msrest.serialization.Model

Trigger based on total requests.

Parameters

  • count (int) – Request Count.

  • time_interval (str) – Time interval.

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

Bases: msrest.serialization.Model

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • location (str) – Required. Resource Location.

  • tags (dict[str, str]) – Resource tags.

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

Bases: msrest.serialization.Model

Metrics availability and retention.

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

Variables

  • time_grain (str) – Time grain .

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

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

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

Metadata for the metrics.

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • resource_metric_definition_name (ResourceMetricName) – Name of the metric.

  • unit (str) – Unit of the metric.

  • primary_aggregation_type (str) – Primary aggregation type.

  • metric_availabilities (list[ResourceMetricAvailability]) – List of time grains supported for the metric together with retention period.

  • resource_uri (str) – Resource URI.

  • resource_metric_definition_id (str) – Resource ID.

  • properties (dict[str, str]) – Resource metric definition properties.

Parameters

kind (str) – Kind of resource.

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

Bases: msrest.serialization.Model

Name of a metric for any resource .

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

Variables

  • value (str) – metric name value.

  • localized_value (str) – Localized metric name value.

class azure.mgmt.web.v2015_08_01.models.ServiceSpecification(*, metric_specifications=None, **kwargs)[source]

Bases: msrest.serialization.Model

Resource metrics service provided by Microsoft.Insights resource provider.

Parameters

metric_specifications (list[MetricSpecification]) –

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

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

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • state (str) – Current state of the app.

  • host_names (list[str]) – Hostnames associated with the app.

  • repository_site_name (str) – Name of the repository site.

  • usage_state (str or UsageState) – State indicating whether the app has exceeded its quota usage. Read-only. Possible values include: ‘Normal’, ‘Exceeded’

  • enabled_host_names (list[str]) – Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

  • availability_state (str or SiteAvailabilityState) – Management information availability state for the app. Possible values include: ‘Normal’, ‘Limited’, ‘DisasterRecoveryMode’

  • last_modified_time_utc (datetime) – Last time the app was modified, in UTC. Read-only.

  • traffic_manager_host_names (list[str]) – Azure Traffic Manager hostnames associated with the app. Read-only.

  • target_swap_slot (str) – Specifies which deployment slot this app will swap into. Read-only.

  • outbound_ip_addresses (str) – List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.

  • possible_outbound_ip_addresses (str) – List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.

  • suspended_till (datetime) – App suspended till in case memory-time quota is exceeded.

  • max_number_of_workers (int) – Maximum number of workers. This only applies to Functions container.

  • resource_group (str) – Name of the resource group the app belongs to. Read-only.

  • is_default_container (bool) – <code>true</code> if the app is a default container; otherwise, <code>false</code>.

  • default_host_name (str) – Default hostname of the app. Read-only.

  • slot_swap_status (SlotSwapStatus) – Status of the last deployment slot swap operation.

Parameters

  • kind (str) – Kind of resource.

  • location (str) – Required. Resource Location.

  • tags (dict[str, str]) – Resource tags.

  • enabled (bool) – <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).

  • host_name_ssl_states (list[HostNameSslState]) – Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

  • server_farm_id (str) – Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”.

  • reserved (bool) – <code>true</code> if reserved; otherwise, <code>false</code>. Default value: False .

  • site_config (SiteConfig) – Configuration of the app.

  • scm_site_also_stopped (bool) – <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. Default value: False .

  • hosting_environment_profile (HostingEnvironmentProfile) – App Service Environment to use for the app.

  • client_affinity_enabled (bool) – <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.

  • client_cert_enabled (bool) – <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.

  • host_names_disabled (bool) – <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.

  • container_size (int) – Size of the function container.

  • daily_memory_time_quota (int) – Maximum allowed daily memory-time quota (applicable on dynamic apps only).

  • cloning_info (CloningInfo) – If specified during app creation, the app is cloned from a source app.

  • snapshot_info (SnapshotRecoveryRequest) – If specified during app creation, the app is created from a previous snapshot.

  • https_only (bool) – HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

  • identity (ManagedServiceIdentity) –

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

Bases: msrest.serialization.Model

Configuration of an App Service app.

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

Parameters

  • number_of_workers (int) – Number of workers.

  • default_documents (list[str]) – Default documents.

  • net_framework_version (str) – .NET Framework version. Default value: “v4.6” .

  • php_version (str) – Version of PHP.

  • python_version (str) – Version of Python.

  • node_version (str) – Version of Node.js.

  • linux_fx_version (str) – Linux App Framework and version

  • request_tracing_enabled (bool) – <code>true</code> if request tracing is enabled; otherwise, <code>false</code>.

  • request_tracing_expiration_time (datetime) – Request tracing expiration time.

  • remote_debugging_enabled (bool) – <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>.

  • remote_debugging_version (str) – Remote debugging version.

  • http_logging_enabled (bool) – <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>.

  • logs_directory_size_limit (int) – HTTP logs directory size limit.

  • detailed_error_logging_enabled (bool) – <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>.

  • publishing_username (str) – Publishing user name.

  • app_settings (list[NameValuePair]) – Application settings.

  • connection_strings (list[ConnStringInfo]) – Connection strings.

  • handler_mappings (list[HandlerMapping]) – Handler mappings.

  • document_root (str) – Document root.

  • scm_type (str or ScmType) – SCM type. Possible values include: ‘None’, ‘Dropbox’, ‘Tfs’, ‘LocalGit’, ‘GitHub’, ‘CodePlexGit’, ‘CodePlexHg’, ‘BitbucketGit’, ‘BitbucketHg’, ‘ExternalGit’, ‘ExternalHg’, ‘OneDrive’, ‘VSO’

  • use32_bit_worker_process (bool) – <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>.

  • web_sockets_enabled (bool) – <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>.

  • always_on (bool) – <code>true</code> if Always On is enabled; otherwise, <code>false</code>.

  • java_version (str) – Java version.

  • java_container (str) – Java container.

  • java_container_version (str) – Java container version.

  • app_command_line (str) – App command line to launch.

  • managed_pipeline_mode (str or ManagedPipelineMode) – Managed pipeline mode. Possible values include: ‘Integrated’, ‘Classic’

  • virtual_applications (list[VirtualApplication]) – Virtual applications.

  • load_balancing (str or SiteLoadBalancing) – Site load balancing. Possible values include: ‘WeightedRoundRobin’, ‘LeastRequests’, ‘LeastResponseTime’, ‘WeightedTotalTraffic’, ‘RequestHash’

  • experiments (Experiments) – This is work around for polymorphic types.

  • limits (SiteLimits) – Site limits.

  • auto_heal_enabled (bool) – <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.

  • auto_heal_rules (AutoHealRules) – Auto Heal rules.

  • tracing_options (str) – Tracing options.

  • vnet_name (str) – Virtual Network name.

  • cors (CorsSettings) – Cross-Origin Resource Sharing (CORS) settings.

  • push (PushSettings) – Push endpoint settings.

  • api_definition (ApiDefinitionInfo) – Information about the formal API definition for the app.

  • auto_swap_slot_name (str) – Auto-swap slot name.

  • local_my_sql_enabled (bool) – <code>true</code> to enable local MySQL; otherwise, <code>false</code>. Default value: False .

  • ip_security_restrictions (list[IpSecurityRestriction]) – IP security restrictions.

  • http20_enabled (bool) – Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value: True .

  • min_tls_version (str or SupportedTlsVersions) – MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: ‘1.0’, ‘1.1’, ‘1.2’

Variables

machine_key (SiteMachineKey) – Site MachineKey.

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

Bases: msrest.serialization.Model

Metric limits set on an app.

Parameters

  • max_percentage_cpu (float) – Maximum allowed CPU usage percentage.

  • max_memory_in_mb (long) – Maximum allowed memory usage in MB.

  • max_disk_size_in_mb (long) – Maximum allowed disk size usage in MB.

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

Bases: msrest.serialization.Model

MachineKey of an app.

Parameters

  • validation (str) – MachineKey validation.

  • validation_key (str) – Validation key.

  • decryption (str) – Algorithm used for decryption.

  • decryption_key (str) – Decryption key.

class azure.mgmt.web.v2015_08_01.models.SiteSeal(*, html: str, **kwargs)[source]

Bases: msrest.serialization.Model

Site seal.

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

Parameters

html (str) – Required. HTML snippet

class azure.mgmt.web.v2015_08_01.models.SiteSealRequest(*, light_theme: bool = None, locale: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Site seal request.

Parameters

  • light_theme (bool) – If <code>true</code> use the light color theme for site seal; otherwise, use the default color theme.

  • locale (str) – Locale of site seal.

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

Bases: msrest.serialization.Model

Description of the App Service plan scale options.

Parameters

  • minimum (int) – Minimum number of workers for this App Service plan SKU.

  • maximum (int) – Maximum number of workers for this App Service plan SKU.

  • default (int) – Default number of workers for this App Service plan SKU.

  • scale_type (str) – Available scale configurations for an App Service plan.

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

Bases: msrest.serialization.Model

Description of a SKU for a scalable resource.

Parameters

  • name (str) – Name of the resource SKU.

  • tier (str) – Service tier of the resource SKU.

  • size (str) – Size specifier of the resource SKU.

  • family (str) – Family code of the resource SKU.

  • capacity (int) – Current number of instances assigned to the resource.

  • sku_capacity (SkuCapacity) – Min, max, and default scale values of the SKU.

  • locations (list[str]) – Locations of the SKU.

  • capabilities (list[Capability]) – Capabilities of the SKU, e.g., is traffic manager enabled?

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

Bases: msrest.serialization.Model

The status of the last successful slot swap operation.

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

Variables

  • timestamp_utc (datetime) – The time the last successful slot swap completed.

  • source_slot_name (str) – The source slot of the last swap operation.

  • destination_slot_name (str) – The destination slot of the last swap operation.

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

Bases: msrest.serialization.Model

Trigger based on request execution time.

Parameters

  • time_taken (str) – Time taken.

  • count (int) – Request Count.

  • time_interval (str) – Time interval.

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

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

Details about app recovery operation.

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • snapshot_time (str) – Point in time in which the app recovery should be attempted, formatted as a DateTime string.

  • recovery_target (SnapshotRecoveryTarget) – Specifies the web app that snapshot contents will be written to.

  • overwrite (bool) – Required. If <code>true</code> the recovery operation can overwrite source app; otherwise, <code>false</code>.

  • recover_configuration (bool) – If true, site configuration, in addition to content, will be reverted.

  • ignore_conflicting_host_names (bool) – If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.

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

Bases: msrest.serialization.Model

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

Parameters

  • location (str) – Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS

  • id (str) – ARM resource ID of the target app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

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

Bases: msrest.serialization.Model

Trigger based on status code.

Parameters

  • status (int) – HTTP status code.

  • sub_status (int) – Request Sub Status.

  • win32_status (int) – Win32 error code.

  • count (int) – Request Count.

  • time_interval (str) – Time interval.

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

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

User credentials used for publishing activity.

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • user_name (str) – Username

  • publishing_user_name (str) – Required. Username used for publishing.

  • publishing_password (str) – Password used for publishing.

  • publishing_password_hash (str) – Password hash used for publishing.

  • publishing_password_hash_salt (str) – Password hash salt used for publishing.

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

Bases: msrest.serialization.Model

Virtual application in an app.

Parameters

  • virtual_path (str) – Virtual path.

  • physical_path (str) – Physical path.

  • preload_enabled (bool) – <code>true</code> if preloading is enabled; otherwise, <code>false</code>.

  • virtual_directories (list[VirtualDirectory]) – Virtual directories for virtual application.

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

Bases: msrest.serialization.Model

Directory for virtual application.

Parameters

  • virtual_path (str) – Path to virtual application.

  • physical_path (str) – Physical path.

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

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

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • vnet_name (str) – The Virtual Network name.

  • vpn_package_uri (str) – Required. The URI where the VPN package can be downloaded.

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

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

Virtual Network information contract.

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

  • cert_thumbprint (str) – The client certificate thumbprint.

  • routes (list[VnetRoute]) – The routes that this Virtual Network connection uses.

  • resync_required (bool) – <code>true</code> if a resync is required; otherwise, <code>false</code>.

Parameters

  • kind (str) – Kind of resource.

  • vnet_resource_id (str) – The Virtual Network’s resource ID.

  • cert_blob (bytearray) – A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.

  • dns_servers (str) – DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.

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

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

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

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

Variables

  • id (str) – Resource Id.

  • name (str) – Resource Name.

  • type (str) – Resource type.

Parameters

  • kind (str) – Kind of resource.

  • vnet_route_name (str) – The name of this route. This is only returned by the server and does not need to be set by the client.

  • start_address (str) – The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.

  • end_address (str) – The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.

  • route_type (str or RouteType) – The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app’s routes with those from a Virtual Network. Possible values include: ‘DEFAULT’, ‘INHERITED’, ‘STATIC’

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServiceCertificateOrder object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of AppServiceCertificateResource object

Bring async to Paging.

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

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of CsmOperationDescription object

Bring async to Paging.

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

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

system_assigned = 'SystemAssigned'
class azure.mgmt.web.v2015_08_01.models.AutoHealActionType[source]

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

bitbucket_git = 'BitbucketGit'
bitbucket_hg = 'BitbucketHg'
code_plex_git = 'CodePlexGit'
code_plex_hg = 'CodePlexHg'
dropbox = 'Dropbox'
external_git = 'ExternalGit'
external_hg = 'ExternalHg'
git_hub = 'GitHub'
local_git = 'LocalGit'
none = 'None'
one_drive = 'OneDrive'
tfs = 'Tfs'
vso = 'VSO'
class azure.mgmt.web.v2015_08_01.models.ManagedPipelineMode[source]

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

one_full_stop_one = '1.1'
one_full_stop_two = '1.2'
one_full_stop_zero = '1.0'
class azure.mgmt.web.v2015_08_01.models.SslState[source]

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
pending = 'Pending'
ready = 'Ready'