azure.mgmt.web.models module¶
-
exception
azure.mgmt.web.models.
DefaultErrorResponseException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘DefaultErrorResponse’.
Parameters: - deserialize – A deserializer
- response – Server response to be deserialized.
-
class
azure.mgmt.web.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.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.models.resource_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.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.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.models.resource_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.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.models.proxy_only_resource_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.models.
AppServiceCertificatePatchResource
(*, kind: str = None, key_vault_id: str = None, key_vault_secret_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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.models.
CertificateEmail
(*, kind: str = None, email_id: str = None, time_stamp=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
SSL certificate email.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- email_id (str) – Email id.
- time_stamp (datetime) – Time stamp.
-
class
azure.mgmt.web.models.
CertificateOrderAction
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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.
- 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.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.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.models.proxy_only_resource_py3.ProxyOnlyResource
Class representing certificate reissue request.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: 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.models.
RenewCertificateOrderRequest
(*, kind: str = None, key_size: int = None, csr: str = None, is_private_key_external: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Class representing certificate renew request.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: 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.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.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.models.
VnetRoute
(*, kind: str = None, start_address: str = None, end_address: str = None, route_type=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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: Parameters: - kind (str) – Kind of resource.
- start_address (str) – The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
- end_address (str) – The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
- route_type (str or RouteType) – The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app’s routes with those from a Virtual Network. Possible values include: ‘DEFAULT’, ‘INHERITED’, ‘STATIC’
-
class
azure.mgmt.web.models.
VnetInfo
(*, kind: str = None, vnet_resource_id: str = None, cert_blob: bytearray = None, dns_servers: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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.models.
VnetGateway
(*, vpn_package_uri: str, kind: str = None, vnet_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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: 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.models.
User
(*, publishing_user_name: str, kind: str = None, publishing_password: str = None, publishing_password_hash: str = None, publishing_password_hash_salt: str = None, scm_uri: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
User crendentials 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: Parameters: - kind (str) – Kind of resource.
- 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.
- scm_uri (str) – Url of SCM site.
-
class
azure.mgmt.web.models.
Snapshot
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A snapshot of an app.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.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.models.
ResourceMetricDefinition
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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.
- 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.
- properties (dict[str, str]) – Resource metric definition properties.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.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.models.proxy_only_resource_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: 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.models.
Identifier
(*, kind: str = None, identifier_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A domain specific resource identifier.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- identifier_id (str) – String representation of the identity.
-
class
azure.mgmt.web.models.
HybridConnectionKey
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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: Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.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.models.proxy_only_resource_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: 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.models.
DeletedSite
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A deleted app.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- deleted_site_id (int) – Numeric id for the deleted site
- deleted_timestamp (str) – Time in UTC when the app was deleted.
- subscription (str) – Subscription containing the deleted site
- resource_group (str) – ResourceGroup that contained the deleted site
- deleted_site_name (str) – Name of the deleted site
- slot (str) – Slot of the deleted site
- deleted_site_kind (str) – Kind of site that was deleted
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.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: Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
ManagedServiceIdentity
(*, type=None, identity_ids=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’, ‘UserAssigned’
- identity_ids (list[str]) – Array of UserAssigned managed service identities.
Variables: - tenant_id (str) – Tenant of managed service identity.
- principal_id (str) – Principal Id of managed service identity.
-
class
azure.mgmt.web.models.
SlotSwapStatus
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The status of the last successfull slot swap operation.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - timestamp_utc (datetime) – The time the last successful slot swap completed.
- source_slot_name (str) – The source slot of the last swap operation.
- destination_slot_name (str) – The destination slot of the last swap operation.
-
class
azure.mgmt.web.models.
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, **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.
-
class
azure.mgmt.web.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:
-
class
azure.mgmt.web.models.
IpSecurityRestriction
(*, ip_address: str, subnet_mask: str = None, action: str = None, tag=None, priority: int = None, name: str = None, description: 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. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.
- subnet_mask (str) – Subnet mask for the range of IP addresses the restriction is valid for.
- action (str) – Allow or Deny access for this IP range.
- tag (str or IpFilterTag) – Defines what this IP filter will be used for. This is to support IP filtering on proxies. Possible values include: ‘Default’, ‘XffProxy’
- priority (int) – Priority of IP restriction rule.
- name (str) – IP restriction rule name.
- description (str) – IP restriction rule description.
-
class
azure.mgmt.web.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.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.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.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.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.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.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.models.
AutoHealTriggers
(*, requests=None, private_bytes_in_kb: int = None, status_codes=None, slow_requests=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Triggers for auto-heal.
Parameters: - requests (RequestsBasedTrigger) – A rule based on total requests.
- private_bytes_in_kb (int) – A rule based on private bytes.
- status_codes (list[StatusCodesBasedTrigger]) – A rule based on status codes.
- slow_requests (SlowRequestsBasedTrigger) – A rule based on request execution time.
-
class
azure.mgmt.web.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.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.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 to add/remove from <code>ReroutePercentage</code> until it reaches <code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specificed in <code>ChangeIntervalInMinutes</code>. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.
- change_interval_in_minutes (int) – Specifies interval in mimuntes to reevaluate ReroutePercentage.
- min_reroute_percentage (float) – Specifies lower boundary above which ReroutePercentage will stay.
- max_reroute_percentage (float) – Specifies upper boundary below which ReroutePercentage will stay.
- change_decision_callback_url (str) – Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/
- name (str) – Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
-
class
azure.mgmt.web.models.
Experiments
(*, ramp_up_rules=None, **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.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.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.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.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.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.models.
AzureStorageInfoValue
(*, type=None, account_name: str = None, share_name: str = None, access_key: str = None, mount_path: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Azure Files or Blob Storage access information value for dictionary storage.
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: - type (str or AzureStorageType) – Type of storage. Possible values include: ‘AzureFiles’, ‘AzureBlob’
- account_name (str) – Name of the storage account.
- share_name (str) – Name of the file share (container name, for Blob storage).
- access_key (str) – Access key for the storage account.
- mount_path (str) – Path to mount the storage within the site’s runtime environment.
Variables: state (str or AzureStorageState) – State of the storage account. Possible values include: ‘Ok’, ‘InvalidCredentials’, ‘InvalidShare’
-
class
azure.mgmt.web.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.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, windows_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, azure_storage_accounts=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, managed_service_identity_id: int = None, x_managed_service_identity_id: int = None, ip_security_restrictions=None, http20_enabled: bool = True, min_tls_version=None, ftps_state=None, reserved_instance_count: int = 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
- windows_fx_version (str) – Xenon 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.
- azure_storage_accounts (dict[str, AzureStorageInfoValue]) – User-provided Azure storage accounts.
- 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 polymophic types.
- limits (SiteLimits) – Site limits.
- auto_heal_enabled (bool) – <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.
- auto_heal_rules (AutoHealRules) – Auto Heal rules.
- tracing_options (str) – Tracing options.
- vnet_name (str) – Virtual Network name.
- cors (CorsSettings) – Cross-Origin Resource Sharing (CORS) settings.
- push (PushSettings) – Push endpoint settings.
- api_definition (ApiDefinitionInfo) – Information about the formal API definition for the app.
- auto_swap_slot_name (str) – Auto-swap slot name.
- local_my_sql_enabled (bool) – <code>true</code> to enable local MySQL; otherwise, <code>false</code>. Default value: False .
- managed_service_identity_id (int) – Managed Service Identity Id
- x_managed_service_identity_id (int) – Explicit Managed Service Identity Id
- 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’
- ftps_state (str or FtpsState) – State of FTP / FTPS service. Possible values include: ‘AllAllowed’, ‘FtpsOnly’, ‘Disabled’
- reserved_instance_count (int) – Number of reserved instances. This setting only applies to the Consumption Plan
Variables: machine_key (SiteMachineKey) – Site MachineKey.
-
class
azure.mgmt.web.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.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, is_xenon: bool = False, hyper_v: 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, https_only: bool = None, identity=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.resource_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 .
- is_xenon (bool) – Obsolete: Hyper-V sandbox. Default value: False .
- hyper_v (bool) – Hyper-V sandbox. 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.
- https_only (bool) – HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests
- identity (ManagedServiceIdentity) –
-
class
azure.mgmt.web.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.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.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.models.
AppServicePlan
(*, location: 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, free_offer_expiration_time=None, reserved: bool = False, is_xenon: bool = False, hyper_v: bool = False, target_worker_count: int = None, target_worker_size_id: int = None, sku=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.resource_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.
- 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.
- free_offer_expiration_time (datetime) – The time when the server farm free offer expires.
- reserved (bool) – If Linux app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .
- is_xenon (bool) – Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .
- hyper_v (bool) – If Hyper-V container 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.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: Parameters: - kind (str) – Kind of resource.
- location (str) – Required. Resource Location.
- tags (dict[str, str]) – Resource tags.
-
class
azure.mgmt.web.models.
DefaultErrorResponseErrorDetailsItem
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Detailed errors.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.web.models.
DefaultErrorResponseError
(*, details=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error model.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: details (list[DefaultErrorResponseErrorDetailsItem]) –
-
class
azure.mgmt.web.models.
DefaultErrorResponse
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
App Service error response.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: error (DefaultErrorResponseError) – Error model.
-
class
azure.mgmt.web.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.models.
LogSpecification
(*, name: str = None, display_name: str = None, blob_duration: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Log Definition of a single resource metric.
Parameters: - name (str) –
- display_name (str) –
- blob_duration (str) –
-
class
azure.mgmt.web.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.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.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.models.
ServiceSpecification
(*, metric_specifications=None, log_specifications=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource metrics service provided by Microsoft.Insights resource provider.
Parameters: - metric_specifications (list[MetricSpecification]) –
- log_specifications (list[LogSpecification]) –
-
class
azure.mgmt.web.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.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.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: - name (str) –
- display (CsmOperationDisplay) –
- origin (str) –
- properties (CsmOperationDescriptionProperties) –
-
class
azure.mgmt.web.models.
Address
(*, address1: str, city: str, country: str, postal_code: str, state: str, address2: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Address information for domain registration.
All required parameters must be populated in order to send to Azure.
Parameters: - address1 (str) – Required. First line of an Address.
- address2 (str) – The second line of the Address. Optional.
- city (str) – Required. The city for the address.
- country (str) – Required. The country for the address.
- postal_code (str) – Required. The postal code for the address.
- state (str) – Required. The state or province for the address.
-
class
azure.mgmt.web.models.
Contact
(*, email: str, name_first: str, name_last: str, phone: str, address_mailing=None, fax: str = None, job_title: str = None, name_middle: str = None, organization: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Contact information for domain registration. If ‘Domain Privacy’ option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.
All required parameters must be populated in order to send to Azure.
Parameters: - address_mailing (Address) – Mailing address.
- email (str) – Required. Email address.
- fax (str) – Fax number.
- job_title (str) – Job title.
- name_first (str) – Required. First name.
- name_last (str) – Required. Last name.
- name_middle (str) – Middle name.
- organization (str) – Organization contact belongs to.
- phone (str) – Required. Phone number.
-
class
azure.mgmt.web.models.
HostName
(*, name: str = None, site_names=None, azure_resource_name: str = None, azure_resource_type=None, custom_host_name_dns_record_type=None, host_name_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Details of a hostname derived from a domain.
Parameters: - name (str) – Name of the hostname.
- site_names (list[str]) – List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.
- azure_resource_name (str) – Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.
- azure_resource_type (str or AzureResourceType) – Type of the Azure resource the hostname is assigned to. Possible values include: ‘Website’, ‘TrafficManager’
- custom_host_name_dns_record_type (str or CustomHostNameDnsRecordType) – Type of the DNS record. Possible values include: ‘CName’, ‘A’
- host_name_type (str or HostNameType) – Type of the hostname. Possible values include: ‘Verified’, ‘Managed’
-
class
azure.mgmt.web.models.
DomainPurchaseConsent
(*, agreement_keys=None, agreed_by: str = None, agreed_at=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Domain purchase consent object, representing acceptance of applicable legal agreements.
Parameters: - agreement_keys (list[str]) – List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under <code>TopLevelDomain</code> resource.
- agreed_by (str) – Client IP address.
- agreed_at (datetime) – Timestamp when the agreements were accepted.
-
class
azure.mgmt.web.models.
Domain
(*, location: str, contact_admin, contact_billing, contact_registrant, contact_tech, consent, kind: str = None, tags=None, privacy: bool = None, auto_renew: bool = True, dns_type=None, dns_zone_id: str = None, target_dns_type=None, auth_code: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.resource_py3.Resource
Information about a domain.
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.
- 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[str]) – Name servers.
- created_time (datetime) – Domain creation timestamp.
- expiration_time (datetime) – Domain expiration timestamp.
- last_renewed_time (datetime) – Timestamp when the domain was renewed last time.
- ready_for_dns_record_management (bool) – <code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
- managed_host_names (list[HostName]) – All hostnames derived from the domain and assigned to Azure resources.
- domain_not_renewable_reasons (list[str]) – Reasons why domain is not renewable.
Parameters: - kind (str) – Kind of resource.
- location (str) – Required. Resource Location.
- tags (dict[str, str]) – Resource tags.
- contact_admin (Contact) – Required. Administrative contact.
- contact_billing (Contact) – Required. Billing contact.
- contact_registrant (Contact) – Required. Registrant contact.
- contact_tech (Contact) – Required. Technical contact.
- privacy (bool) – <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>.
- auto_renew (bool) – <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. Default value: True .
- consent (DomainPurchaseConsent) – Required. Legal agreement consent.
- dns_type (str or DnsType) – Current DNS type. Possible values include: ‘AzureDns’, ‘DefaultDomainRegistrarDns’
- dns_zone_id (str) – Azure DNS Zone to use
- target_dns_type (str or DnsType) – Target DNS type (would be used for migration). Possible values include: ‘AzureDns’, ‘DefaultDomainRegistrarDns’
- auth_code (str) –
-
class
azure.mgmt.web.models.
DomainAvailablilityCheckResult
(*, name: str = None, available: bool = None, domain_type=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Domain availablility check result.
Parameters: - name (str) – Name of the domain.
- available (bool) – <code>true</code> if domain can be purchased using CreateDomain API; otherwise, <code>false</code>.
- domain_type (str or DomainType) – Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything. Possible values include: ‘Regular’, ‘SoftDeleted’
-
class
azure.mgmt.web.models.
DomainControlCenterSsoRequest
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Single sign-on request information for domain management.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - url (str) – URL where the single sign-on request is to be made.
- post_parameter_key (str) – Post parameter key.
- post_parameter_value (str) – Post parameter value. Client should use ‘application/x-www-form-urlencoded’ encoding for this value.
-
class
azure.mgmt.web.models.
DomainOwnershipIdentifier
(*, kind: str = None, ownership_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Domain ownership Identifier.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- ownership_id (str) – Ownership Id.
-
class
azure.mgmt.web.models.
DomainPatchResource
(*, contact_admin, contact_billing, contact_registrant, contact_tech, consent, kind: str = None, privacy: bool = None, auto_renew: bool = True, dns_type=None, dns_zone_id: str = None, target_dns_type=None, auth_code: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
ARM resource for a domain.
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.
- 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[str]) – Name servers.
- created_time (datetime) – Domain creation timestamp.
- expiration_time (datetime) – Domain expiration timestamp.
- last_renewed_time (datetime) – Timestamp when the domain was renewed last time.
- ready_for_dns_record_management (bool) – <code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and it is hosted on name servers Azure has programmatic access to.
- managed_host_names (list[HostName]) – All hostnames derived from the domain and assigned to Azure resources.
- domain_not_renewable_reasons (list[str]) – Reasons why domain is not renewable.
Parameters: - kind (str) – Kind of resource.
- contact_admin (Contact) – Required. Administrative contact.
- contact_billing (Contact) – Required. Billing contact.
- contact_registrant (Contact) – Required. Registrant contact.
- contact_tech (Contact) – Required. Technical contact.
- privacy (bool) – <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>.
- auto_renew (bool) – <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. Default value: True .
- consent (DomainPurchaseConsent) – Required. Legal agreement consent.
- dns_type (str or DnsType) – Current DNS type. Possible values include: ‘AzureDns’, ‘DefaultDomainRegistrarDns’
- dns_zone_id (str) – Azure DNS Zone to use
- target_dns_type (str or DnsType) – Target DNS type (would be used for migration). Possible values include: ‘AzureDns’, ‘DefaultDomainRegistrarDns’
- auth_code (str) –
-
class
azure.mgmt.web.models.
DomainRecommendationSearchParameters
(*, keywords: str = None, max_domain_recommendations: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Domain recommendation search parameters.
Parameters: - keywords (str) – Keywords to be used for generating domain recommendations.
- max_domain_recommendations (int) – Maximum number of recommendations.
-
class
azure.mgmt.web.models.
TldLegalAgreement
(*, agreement_key: str, title: str, content: str, url: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Legal agreement for a top level domain.
All required parameters must be populated in order to send to Azure.
Parameters: - agreement_key (str) – Required. Unique identifier for the agreement.
- title (str) – Required. Agreement title.
- content (str) – Required. Agreement details.
- url (str) – URL where a copy of the agreement details is hosted.
-
class
azure.mgmt.web.models.
TopLevelDomain
(*, kind: str = None, privacy: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A top level domain object.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- privacy (bool) – If <code>true</code>, then the top level domain supports domain privacy; otherwise, <code>false</code>.
-
class
azure.mgmt.web.models.
TopLevelDomainAgreementOption
(*, include_privacy: bool = None, for_transfer: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Options for retrieving the list of top level domain legal agreements.
Parameters: - include_privacy (bool) – If <code>true</code>, then the list of agreements will include agreements for domain privacy as well; otherwise, <code>false</code>.
- for_transfer (bool) – If <code>true</code>, then the list of agreements will include agreements for domain transfer as well; otherwise, <code>false</code>.
-
class
azure.mgmt.web.models.
Certificate
(*, location: str, password: str, kind: str = None, tags=None, host_names=None, pfx_blob: bytearray = None, key_vault_id: str = None, key_vault_secret_name: str = None, server_farm_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.resource_py3.Resource
SSL certificate for an 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.
- friendly_name (str) – Friendly name of the certificate.
- subject_name (str) – Subject name of the certificate.
- site_name (str) – App name.
- self_link (str) – Self link.
- issuer (str) – Certificate issuer.
- issue_date (datetime) – Certificate issue Date.
- expiration_date (datetime) – Certificate expriration date.
- thumbprint (str) – Certificate thumbprint.
- valid (bool) – Is the certificate valid?.
- cer_blob (bytearray) – Raw bytes of .cer file
- public_key_hash (str) – Public key hash.
- hosting_environment_profile (HostingEnvironmentProfile) – Specification for the App Service Environment to use for the certificate.
- key_vault_secret_status (str or KeyVaultSecretStatus) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘ExternalPrivateKey’, ‘Unknown’
Parameters: - kind (str) – Kind of resource.
- location (str) – Required. Resource Location.
- tags (dict[str, str]) – Resource tags.
- host_names (list[str]) – Host names the certificate applies to.
- pfx_blob (bytearray) – Pfx blob.
- password (str) – Required. Certificate password.
- key_vault_id (str) – Key Vault Csm resource Id.
- key_vault_secret_name (str) – Key Vault secret name.
- server_farm_id (str) – Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”.
-
class
azure.mgmt.web.models.
CertificatePatchResource
(*, password: str, kind: str = None, host_names=None, pfx_blob: bytearray = None, key_vault_id: str = None, key_vault_secret_name: str = None, server_farm_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
ARM resource for a certificate.
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.
- friendly_name (str) – Friendly name of the certificate.
- subject_name (str) – Subject name of the certificate.
- site_name (str) – App name.
- self_link (str) – Self link.
- issuer (str) – Certificate issuer.
- issue_date (datetime) – Certificate issue Date.
- expiration_date (datetime) – Certificate expriration date.
- thumbprint (str) – Certificate thumbprint.
- valid (bool) – Is the certificate valid?.
- cer_blob (bytearray) – Raw bytes of .cer file
- public_key_hash (str) – Public key hash.
- hosting_environment_profile (HostingEnvironmentProfile) – Specification for the App Service Environment to use for the certificate.
- key_vault_secret_status (str or KeyVaultSecretStatus) – Status of the Key Vault secret. Possible values include: ‘Initialized’, ‘WaitingOnCertificateOrder’, ‘Succeeded’, ‘CertificateOrderFailed’, ‘OperationNotPermittedOnKeyVault’, ‘AzureServiceUnauthorizedToAccessKeyVault’, ‘KeyVaultDoesNotExist’, ‘KeyVaultSecretDoesNotExist’, ‘UnknownError’, ‘ExternalPrivateKey’, ‘Unknown’
Parameters: - kind (str) – Kind of resource.
- host_names (list[str]) – Host names the certificate applies to.
- pfx_blob (bytearray) – Pfx blob.
- password (str) – Required. Certificate password.
- key_vault_id (str) – Key Vault Csm resource Id.
- key_vault_secret_name (str) – Key Vault secret name.
- server_farm_id (str) – Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”.
-
class
azure.mgmt.web.models.
VirtualNetworkProfile
(*, id: str = None, subnet: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specification for using a Virtual Network.
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: - id (str) – Resource id of the Virtual Network.
- subnet (str) – Subnet within the Virtual Network.
Variables:
-
class
azure.mgmt.web.models.
WorkerPool
(*, worker_size_id: int = None, compute_mode=None, worker_size: str = None, worker_count: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Worker pool of an App Service Environment.
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: - worker_size_id (int) – Worker size ID for referencing this worker pool.
- compute_mode (str or ComputeModeOptions) – Shared or dedicated app hosting. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
- worker_size (str) – VM size of the worker pool instances.
- worker_count (int) – Number of instances in the worker pool.
Variables: instance_names (list[str]) – Names of all instances in the worker pool (read only).
-
class
azure.mgmt.web.models.
VirtualIPMapping
(*, virtual_ip: str = None, internal_http_port: int = None, internal_https_port: int = None, in_use: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Virtual IP mapping.
Parameters: - virtual_ip (str) – Virtual IP address.
- internal_http_port (int) – Internal HTTP port.
- internal_https_port (int) – Internal HTTPS port.
- in_use (bool) – Is virtual IP mapping in use.
-
class
azure.mgmt.web.models.
StampCapacity
(*, name: str = None, available_capacity: int = None, total_capacity: int = None, unit: str = None, compute_mode=None, worker_size=None, worker_size_id: int = None, exclude_from_capacity_allocation: bool = None, is_applicable_for_all_compute_modes: bool = None, site_mode: str = None, is_linux: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Stamp capacity information.
Parameters: - name (str) – Name of the stamp.
- available_capacity (long) – Available capacity (# of machines, bytes of storage etc…).
- total_capacity (long) – Total capacity (# of machines, bytes of storage etc…).
- unit (str) – Name of the unit.
- compute_mode (str or ComputeModeOptions) – Shared/dedicated workers. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
- worker_size (str or WorkerSizeOptions) – Size of the machines. Possible values include: ‘Small’, ‘Medium’, ‘Large’, ‘D1’, ‘D2’, ‘D3’, ‘Default’
- worker_size_id (int) – Size ID of machines: 0 - Small 1 - Medium 2 - Large
- exclude_from_capacity_allocation (bool) – If <code>true</code>, it includes basic apps. Basic apps are not used for capacity allocation.
- is_applicable_for_all_compute_modes (bool) – <code>true</code> if capacity is applicable for all apps; otherwise, <code>false</code>.
- site_mode (str) – Shared or Dedicated.
- is_linux (bool) – Is this a linux stamp capacity
-
class
azure.mgmt.web.models.
NetworkAccessControlEntry
(*, action=None, description: str = None, order: int = None, remote_subnet: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Network access control entry.
Parameters: - action (str or AccessControlEntryAction) – Action object. Possible values include: ‘Permit’, ‘Deny’
- description (str) – Description of network access control entry.
- order (int) – Order of precedence.
- remote_subnet (str) – Remote subnet.
-
class
azure.mgmt.web.models.
AppServiceEnvironment
(*, name: str, location: str, virtual_network, worker_pools, vnet_name: str = None, vnet_resource_group_name: str = None, vnet_subnet_name: str = None, internal_load_balancing_mode=None, multi_size: str = None, multi_role_count: int = None, ipssl_address_count: int = None, dns_suffix: str = None, network_access_control_list=None, front_end_scale_factor: int = None, api_management_account_id: str = None, suspended: bool = None, dynamic_cache_enabled: bool = None, cluster_settings=None, user_whitelisted_ip_ranges=None, has_linux_workers: bool = None, ssl_cert_key_vault_id: str = None, ssl_cert_key_vault_secret_name: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Description of an App Service Environment.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Parameters: - name (str) – Required. Name of the App Service Environment.
- location (str) – Required. Location of the App Service Environment, e.g. “West US”.
- vnet_name (str) – Name of the Virtual Network for the App Service Environment.
- vnet_resource_group_name (str) – Resource group of the Virtual Network.
- vnet_subnet_name (str) – Subnet of the Virtual Network.
- virtual_network (VirtualNetworkProfile) – Required. Description of the Virtual Network.
- internal_load_balancing_mode (str or InternalLoadBalancingMode) – Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: ‘None’, ‘Web’, ‘Publishing’
- multi_size (str) – Front-end VM size, e.g. “Medium”, “Large”.
- multi_role_count (int) – Number of front-end instances.
- worker_pools (list[WorkerPool]) – Required. Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
- ipssl_address_count (int) – Number of IP SSL addresses reserved for the App Service Environment.
- dns_suffix (str) – DNS suffix of the App Service Environment.
- network_access_control_list (list[NetworkAccessControlEntry]) – Access control list for controlling traffic to the App Service Environment.
- front_end_scale_factor (int) – Scale factor for front-ends.
- api_management_account_id (str) – API Management Account associated with the App Service Environment.
- suspended (bool) – <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- dynamic_cache_enabled (bool) – True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- cluster_settings (list[NameValuePair]) – Custom settings for changing the behavior of the App Service Environment.
- user_whitelisted_ip_ranges (list[str]) – User added ip ranges to whitelist on ASE db
- has_linux_workers (bool) – Flag that displays whether an ASE has linux workers or not
- ssl_cert_key_vault_id (str) – Key Vault ID for ILB App Service Environment default SSL certificate
- ssl_cert_key_vault_secret_name (str) – Key Vault Secret Name for ILB App Service Environment default SSL certificate
Variables: - provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
- status (str or HostingEnvironmentStatus) – Current status of the App Service Environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’
- database_edition (str) – Edition of the metadata database for the App Service Environment, e.g. “Standard”.
- database_service_objective (str) – Service objective of the metadata database for the App Service Environment, e.g. “S0”.
- upgrade_domains (int) – Number of upgrade domains of the App Service Environment.
- subscription_id (str) – Subscription of the App Service Environment.
- last_action (str) – Last deployment action on the App Service Environment.
- last_action_result (str) – Result of the last deployment action on the App Service Environment.
- allowed_multi_sizes (str) – List of comma separated strings describing which VM sizes are allowed for front-ends.
- allowed_worker_sizes (str) – List of comma separated strings describing which VM sizes are allowed for workers.
- maximum_number_of_machines (int) – Maximum number of VMs in the App Service Environment.
- vip_mappings (list[VirtualIPMapping]) – Description of IP SSL mapping for the App Service Environment.
- environment_capacities (list[StampCapacity]) – Current total, used, and available worker capacities.
- environment_is_healthy (bool) – True/false indicating whether the App Service Environment is healthy.
- environment_status (str) – Detailed message about with results of the last check of the App Service Environment.
- resource_group (str) – Resource group of the App Service Environment.
- default_front_end_scale_factor (int) – Default Scale Factor for FrontEnds.
-
class
azure.mgmt.web.models.
LocalizableString
(*, value: str = None, localized_value: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Localizable string object containing the name and a localized value.
Parameters: - value (str) – Non-localized name.
- localized_value (str) – Localized name.
-
class
azure.mgmt.web.models.
CsmUsageQuota
(*, unit: str = None, next_reset_time=None, current_value: int = None, limit: int = None, name=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Usage of the quota resource.
Parameters: - unit (str) – Units of measurement for the quota resourse.
- next_reset_time (datetime) – Next reset time for the resource counter.
- current_value (long) – The current value of the resource counter.
- limit (long) – The resource limit.
- name (LocalizableString) – Quota name.
-
class
azure.mgmt.web.models.
ErrorEntity
(*, extended_code: str = None, message_template: str = None, parameters=None, inner_errors=None, code: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Body of the error response returned from the API.
Parameters: - extended_code (str) – Type of error.
- message_template (str) – Message template.
- parameters (list[str]) – Parameters for the template.
- inner_errors (list[ErrorEntity]) – Inner errors.
- code (str) – Basic error code.
- message (str) – Any details of the error.
-
class
azure.mgmt.web.models.
Operation
(*, id: str = None, name: str = None, status=None, errors=None, created_time=None, modified_time=None, expiration_time=None, geo_master_operation_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An operation on a resource.
Parameters: - id (str) – Operation ID.
- name (str) – Operation name.
- status (str or OperationStatus) – The current status of the operation. Possible values include: ‘InProgress’, ‘Failed’, ‘Succeeded’, ‘TimedOut’, ‘Created’
- errors (list[ErrorEntity]) – Any errors associate with the operation.
- created_time (datetime) – Time when operation has started.
- modified_time (datetime) – Time when operation has been updated.
- expiration_time (datetime) – Time when operation will expire.
- geo_master_operation_id (str) – Applicable only for stamp operation ids.
-
class
azure.mgmt.web.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.models.
ResourceMetricProperty
(*, key: str = None, value: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource metric property.
Parameters: - key (str) – Key for resource metric property.
- value (str) – Value of pair.
-
class
azure.mgmt.web.models.
ResourceMetricValue
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Value of resource metric.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.web.models.
ResourceMetric
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Object representing a metric for any resource .
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - name (ResourceMetricName) – Name of metric.
- unit (str) – Metric unit.
- time_grain (str) – Metric granularity. E.g PT1H, PT5M, P1D
- start_time (datetime) – Metric start time.
- end_time (datetime) – Metric end time.
- resource_id (str) – Metric resource Id.
- id (str) – Resource Id.
- metric_values (list[ResourceMetricValue]) – Metric values.
- properties (list[ResourceMetricProperty]) – Resource metric properties collection.
-
class
azure.mgmt.web.models.
WebAppCollection
(*, value, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Collection of App Service apps.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Parameters: value (list[Site]) – Required. Collection of resources. Variables: next_link (str) – Link to next page of resources.
-
class
azure.mgmt.web.models.
Solution
(*, id: float = None, display_name: str = None, order: float = None, description: str = None, type=None, data=None, metadata=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Class Representing Solution for problems detected.
Parameters: - id (float) – Solution Id.
- display_name (str) – Display Name of the solution
- order (float) – Order of the solution.
- description (str) – Description of the solution
- type (str or SolutionType) – Type of Solution. Possible values include: ‘QuickSolution’, ‘DeepInvestigation’, ‘BestPractices’
- data (list[list[NameValuePair]]) – Solution Data.
- metadata (list[list[NameValuePair]]) – Solution Metadata.
-
class
azure.mgmt.web.models.
DetectorAbnormalTimePeriod
(*, start_time=None, end_time=None, message: str = None, source: str = None, priority: float = None, meta_data=None, type=None, solutions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Class representing Abnormal Time Period detected.
Parameters: - start_time (datetime) – Start time of the corelated event
- end_time (datetime) – End time of the corelated event
- message (str) – Message describing the event
- source (str) – Represents the name of the Detector
- priority (float) – Represents the rank of the Detector
- meta_data (list[list[NameValuePair]]) – Downtime metadata
- type (str or IssueType) – Represents the type of the Detector. Possible values include: ‘ServiceIncident’, ‘AppDeployment’, ‘AppCrash’, ‘RuntimeIssueDetected’, ‘AseDeployment’, ‘UserIssue’, ‘PlatformIssue’, ‘Other’
- solutions (list[Solution]) – List of proposed solutions
-
class
azure.mgmt.web.models.
AbnormalTimePeriod
(*, start_time=None, end_time=None, events=None, solutions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Class representing Abnormal Time Period identified in diagnosis.
Parameters: - start_time (datetime) – Start time of the downtime
- end_time (datetime) – End time of the downtime
- events (list[DetectorAbnormalTimePeriod]) – List of Possible Cause of downtime
- solutions (list[Solution]) – List of proposed solutions
-
class
azure.mgmt.web.models.
DetectorDefinition
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Class representing detector definition.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- display_name (str) – Display name of the detector
- description (str) – Description of the detector
- rank (float) – Detector Rank
- is_enabled (bool) – Flag representing whether detector is enabled or not.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
DiagnosticMetricSample
(*, timestamp=None, role_instance: str = None, total: float = None, maximum: float = None, minimum: float = None, is_aggregated: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Class representing Diagnostic Metric.
Parameters: - timestamp (datetime) – Time at which metric is measured
- role_instance (str) – Role Instance. Null if this counter is not per instance This is returned and should be whichever instance name we desire to be returned i.e. CPU and Memory return RDWORKERNAME (LargeDed…_IN_0) where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis
- total (float) – Total value of the metric. If multiple measurements are made this will have sum of all.
- maximum (float) – Maximum of the metric sampled during the time period
- minimum (float) – Minimum of the metric sampled during the time period
- is_aggregated (bool) – Whether the values are aggregates across all workers or not
-
class
azure.mgmt.web.models.
DiagnosticMetricSet
(*, name: str = None, unit: str = None, start_time=None, end_time=None, time_grain: str = None, values=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Class representing Diagnostic Metric information.
Parameters: - name (str) – Name of the metric
- unit (str) – Metric’s unit
- start_time (datetime) – Start time of the period
- end_time (datetime) – End time of the period
- time_grain (str) – Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D
- values (list[DiagnosticMetricSample]) – Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}
-
class
azure.mgmt.web.models.
DataSource
(*, instructions=None, data_source_uri=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Class representing data source used by the detectors.
Parameters: - instructions (list[str]) – Instrunctions if any for the data source
- data_source_uri (list[NameValuePair]) – Datasource Uri Links
-
class
azure.mgmt.web.models.
ResponseMetaData
(*, data_source=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
ResponseMetaData.
Parameters: data_source (DataSource) – Source of the Data
-
class
azure.mgmt.web.models.
AnalysisData
(*, source: str = None, detector_definition=None, metrics=None, data=None, detector_meta_data=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Class Representing Detector Evidence used for analysis.
Parameters: - source (str) – Name of the Detector
- detector_definition (DetectorDefinition) – Detector Definition
- metrics (list[DiagnosticMetricSet]) – Source Metrics
- data (list[list[NameValuePair]]) – Additional Source Data
- detector_meta_data (ResponseMetaData) – Detector Meta Data
-
class
azure.mgmt.web.models.
AnalysisDefinition
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Definition of Analysis.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- description (str) – Description of the Analysis
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
DataTableResponseColumn
(*, column_name: str = None, data_type: str = None, column_type: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Column definition.
Parameters: - column_name (str) – Name of the column
- data_type (str) – Data type which looks like ‘String’ or ‘Int32’.
- column_type (str) – Column Type
-
class
azure.mgmt.web.models.
DataTableResponseObject
(*, table_name: str = None, columns=None, rows=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Data Table which defines columns and raw row values.
Parameters: - table_name (str) – Name of the table
- columns (list[DataTableResponseColumn]) – List of columns with data types
- rows (list[list[str]]) – Raw row values
-
class
azure.mgmt.web.models.
DetectorInfo
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Definition of Detector.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - description (str) – Short description of the detector and its purpose
- category (str) – Support Category
- sub_category (str) – Support Sub Category
- support_topic_id (str) – Support Topic Id
-
class
azure.mgmt.web.models.
Rendering
(*, type=None, title: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Instructions for rendering the data.
Parameters: - type (str or RenderingType) – Rendering Type. Possible values include: ‘NoGraph’, ‘Table’, ‘TimeSeries’, ‘TimeSeriesPerInstance’
- title (str) – Title of data
- description (str) – Description of the data that will help it be interpreted
-
class
azure.mgmt.web.models.
DiagnosticData
(*, table=None, rendering_properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Set of data with rendering instructions.
Parameters: - table (DataTableResponseObject) – Data in table form
- rendering_properties (Rendering) – Properties that describe how the table should be rendered
-
class
azure.mgmt.web.models.
DetectorResponse
(*, kind: str = None, metadata=None, dataset=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Class representing Response from Detector.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- metadata (DetectorInfo) – metadata for the detector
- dataset (list[DiagnosticData]) – Data Set
-
class
azure.mgmt.web.models.
DiagnosticAnalysis
(*, kind: str = None, start_time=None, end_time=None, abnormal_time_periods=None, payload=None, non_correlated_detectors=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Class representing a diagnostic analysis done on an application.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- start_time (datetime) – Start time of the period
- end_time (datetime) – End time of the period
- abnormal_time_periods (list[AbnormalTimePeriod]) – List of time periods.
- payload (list[AnalysisData]) – Data by each detector
- non_correlated_detectors (list[DetectorDefinition]) – Data by each detector for detectors that did not corelate
-
class
azure.mgmt.web.models.
DiagnosticCategory
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Class representing detector definition.
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.
- description (str) – Description of the diagnostic category
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
DiagnosticDetectorResponse
(*, kind: str = None, start_time=None, end_time=None, issue_detected: bool = None, detector_definition=None, metrics=None, abnormal_time_periods=None, data=None, response_meta_data=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Class representing Reponse from Diagnostic Detectors.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- start_time (datetime) – Start time of the period
- end_time (datetime) – End time of the period
- issue_detected (bool) – Flag representing Issue was detected.
- detector_definition (DetectorDefinition) – Detector’s definition
- metrics (list[DiagnosticMetricSet]) – Metrics provided by the detector
- abnormal_time_periods (list[DetectorAbnormalTimePeriod]) – List of Correlated events found by the detector
- data (list[list[NameValuePair]]) – Additional Data that detector wants to send.
- response_meta_data (ResponseMetaData) – Meta Data
-
class
azure.mgmt.web.models.
StackMinorVersion
(*, display_version: str = None, runtime_version: str = None, is_default: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Application stack minor version.
Parameters: - display_version (str) – Application stack minor version (display only).
- runtime_version (str) – Application stack minor version (runtime only).
- is_default (bool) – <code>true</code> if this is the default minor version; otherwise, <code>false</code>.
-
class
azure.mgmt.web.models.
StackMajorVersion
(*, display_version: str = None, runtime_version: str = None, is_default: bool = None, minor_versions=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Application stack major version.
Parameters: - display_version (str) – Application stack major version (display only).
- runtime_version (str) – Application stack major version (runtime only).
- is_default (bool) – <code>true</code> if this is the default major version; otherwise, <code>false</code>.
- minor_versions (list[StackMinorVersion]) – Minor versions associated with the major version.
-
class
azure.mgmt.web.models.
ApplicationStack
(*, name: str = None, display: str = None, dependency: str = None, major_versions=None, frameworks=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Application stack.
Parameters: - name (str) – Application stack name.
- display (str) – Application stack display name.
- dependency (str) – Application stack dependency.
- major_versions (list[StackMajorVersion]) – List of major versions available.
- frameworks (list[ApplicationStack]) – List of frameworks associated with application stack.
-
class
azure.mgmt.web.models.
Recommendation
(*, kind: str = None, creation_time=None, recommendation_id: str = None, resource_id: str = None, resource_scope=None, rule_name: str = None, display_name: str = None, message: str = None, level=None, channels=None, action_name: str = None, enabled: int = None, states=None, start_time=None, end_time=None, next_notification_time=None, notification_expiration_time=None, notified_time=None, score: float = None, is_dynamic: bool = None, extension_name: str = None, blade_name: str = None, forward_link: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Represents a recommendation result generated by the recommendation engine.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- creation_time (datetime) – Timestamp when this instance was created.
- recommendation_id (str) – A GUID value that each recommendation object is associated with.
- resource_id (str) – Full ARM resource ID string that this recommendation object is associated with.
- resource_scope (str or ResourceScopeType) – Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. Possible values include: ‘ServerFarm’, ‘Subscription’, ‘WebSite’
- rule_name (str) – Unique name of the rule.
- display_name (str) – UI friendly name of the rule (may not be unique).
- message (str) – Recommendation text.
- level (str or NotificationLevel) – Level indicating how critical this recommendation can impact. Possible values include: ‘Critical’, ‘Warning’, ‘Information’, ‘NonUrgentSuggestion’
- channels (str or Channels) – List of channels that this recommendation can apply. Possible values include: ‘Notification’, ‘Api’, ‘Email’, ‘Webhook’, ‘All’
- action_name (str) – Name of action recommended by this object.
- enabled (int) – True if this recommendation is still valid (i.e. “actionable”). False if it is invalid.
- states (list[str]) – The list of states of this recommendation. If it’s null then it shoud be considered “Active”.
- start_time (datetime) – The beginning time in UTC of a range that the recommendation refers to.
- end_time (datetime) – The end time in UTC of a range that the recommendation refers to.
- next_notification_time (datetime) – When to notify this recommendation next in UTC. Null means that this will never be notified anymore.
- notification_expiration_time (datetime) – Date and time in UTC when this notification expires.
- notified_time (datetime) – Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn’t been notified yet.
- score (float) – A metric value measured by the rule.
- is_dynamic (bool) – True if this is associated with a dynamically added rule
- extension_name (str) – Extension name of the portal if exists.
- blade_name (str) – Deep link to a blade on the portal.
- forward_link (str) – Forward link to an external document associated with the rule.
-
class
azure.mgmt.web.models.
RecommendationRule
(*, kind: str = None, recommendation_name: str = None, display_name: str = None, message: str = None, recommendation_id: str = None, description: str = None, action_name: str = None, level=None, channels=None, is_dynamic: bool = None, extension_name: str = None, blade_name: str = None, forward_link: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Represents a recommendation rule that the recommendation engine can perform.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- recommendation_name (str) – Unique name of the rule.
- display_name (str) – UI friendly name of the rule.
- message (str) – Localized name of the rule (Good for UI).
- recommendation_id (str) – Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn’t exist, it is set to null.
- description (str) – Localized detailed description of the rule.
- action_name (str) – Name of action that is recommended by this rule in string.
- level (str or NotificationLevel) – Level of impact indicating how critical this rule is. Possible values include: ‘Critical’, ‘Warning’, ‘Information’, ‘NonUrgentSuggestion’
- channels (str or Channels) – List of available channels that this rule applies. Possible values include: ‘Notification’, ‘Api’, ‘Email’, ‘Webhook’, ‘All’
- is_dynamic (bool) – True if this is associated with a dynamically added rule
- extension_name (str) – Extension name of the portal if exists. Applicable to dynamic rule only.
- blade_name (str) – Deep link to a blade on the portal. Applicable to dynamic rule only.
- forward_link (str) – Forward link to an external document associated with the rule. Applicable to dynamic rule only.
-
class
azure.mgmt.web.models.
BillingMeter
(*, kind: str = None, meter_id: str = None, billing_location: str = None, short_name: str = None, friendly_name: str = None, resource_type: str = None, os_type: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- meter_id (str) – Meter GUID onboarded in Commerce
- billing_location (str) – Azure Location of billable resource
- short_name (str) – Short Name from App Service Azure pricing Page
- friendly_name (str) – Friendly name of the meter
- resource_type (str) – App Service ResourceType meter used for
- os_type (str) – App Service OS type meter used for
-
class
azure.mgmt.web.models.
CsmMoveResourceEnvelope
(*, target_resource_group: str = None, resources=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Object with a list of the resources that need to be moved and the resource group they should be moved to.
Parameters: - target_resource_group (str) –
- resources (list[str]) –
-
class
azure.mgmt.web.models.
GeoRegion
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Geographical region.
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.
- description (str) – Region description.
- display_name (str) – Display name for region.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
HostingEnvironmentDeploymentInfo
(*, name: str = None, location: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Information needed to create resources on an App Service Environment.
Parameters: - name (str) – Name of the App Service Environment.
- location (str) – Location of the App Service Environment.
-
class
azure.mgmt.web.models.
DeploymentLocations
(*, locations=None, hosting_environments=None, hosting_environment_deployment_infos=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
List of available locations (regions or App Service Environments) for deployment of App Service resources.
Parameters: - locations (list[GeoRegion]) – Available regions.
- hosting_environments (list[AppServiceEnvironment]) – Available App Service Environments with full descriptions of the environments.
- hosting_environment_deployment_infos (list[HostingEnvironmentDeploymentInfo]) – Available App Service Environments with basic information.
-
class
azure.mgmt.web.models.
GlobalCsmSkuDescription
(*, name: str = None, tier: str = None, size: str = None, family: str = None, capacity=None, locations=None, capabilities=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A Global SKU Description.
Parameters: - name (str) – Name of the resource SKU.
- tier (str) – Service Tier of the resource SKU.
- size (str) – Size specifier of the resource SKU.
- family (str) – Family code of 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.models.
PremierAddOnOffer
(*, kind: str = None, sku: str = None, product: str = None, vendor: str = None, promo_code_required: bool = None, quota: int = None, web_hosting_plan_restrictions=None, privacy_policy_url: str = None, legal_terms_url: str = None, marketplace_publisher: str = None, marketplace_offer: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Premier add-on offer.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- sku (str) – Premier add on SKU.
- product (str) – Premier add on offer Product.
- vendor (str) – Premier add on offer Vendor.
- promo_code_required (bool) – <code>true</code> if promotion code is required; otherwise, <code>false</code>.
- quota (int) – Premier add on offer Quota.
- web_hosting_plan_restrictions (str or AppServicePlanRestrictions) – App Service plans this offer is restricted to. Possible values include: ‘None’, ‘Free’, ‘Shared’, ‘Basic’, ‘Standard’, ‘Premium’
- privacy_policy_url (str) – Privacy policy URL.
- legal_terms_url (str) – Legal terms URL.
- marketplace_publisher (str) – Marketplace publisher.
- marketplace_offer (str) – Marketplace offer.
-
class
azure.mgmt.web.models.
ResourceNameAvailability
(*, name_available: bool = None, reason=None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Information regarding availbility of a resource name.
Parameters: - name_available (bool) – <code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.
- reason (str or InAvailabilityReasonType) – <code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable. Possible values include: ‘Invalid’, ‘AlreadyExists’
- message (str) – If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
-
class
azure.mgmt.web.models.
ResourceNameAvailabilityRequest
(*, name: str, type, is_fqdn: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource name availability request content.
All required parameters must be populated in order to send to Azure.
Parameters: - name (str) – Required. Resource name to verify.
- type (str or CheckNameResourceTypes) – Required. Resource type used for verification. Possible values include: ‘Site’, ‘Slot’, ‘HostingEnvironment’, ‘PublishingUser’, ‘Microsoft.Web/sites’, ‘Microsoft.Web/sites/slots’, ‘Microsoft.Web/hostingEnvironments’, ‘Microsoft.Web/publishingUsers’
- is_fqdn (bool) – Is fully qualified domain name.
-
class
azure.mgmt.web.models.
SkuInfos
(*, resource_type: str = None, skus=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Collection of SKU information.
Parameters: - resource_type (str) – Resource type that this SKU applies to.
- skus (list[GlobalCsmSkuDescription]) – List of SKUs the subscription is able to use.
-
class
azure.mgmt.web.models.
SourceControl
(*, kind: str = None, token: str = None, token_secret: str = None, refresh_token: str = None, expiration_time=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
The source control OAuth token.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- 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.
ValidateRequest
(*, name: str, type, location: str, server_farm_id: str = None, sku_name: str = None, need_linux_workers: bool = None, is_spot: bool = None, capacity: int = None, hosting_environment: str = None, is_xenon: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource validation request content.
All required parameters must be populated in order to send to Azure.
Parameters: - name (str) – Required. Resource name to verify.
- type (str or ValidateResourceTypes) – Required. Resource type used for verification. Possible values include: ‘ServerFarm’, ‘Site’
- location (str) – Required. Expected location of the resource.
- server_farm_id (str) – ARM resource ID of an App Service plan that would host the app.
- sku_name (str) – Name of the target SKU for the App Service plan.
- need_linux_workers (bool) – <code>true</code> if App Service plan is for Linux workers; otherwise, <code>false</code>.
- is_spot (bool) – <code>true</code> if App Service plan is for Spot instances; otherwise, <code>false</code>.
- capacity (int) – Target capacity of the App Service plan (number of VM’s).
- hosting_environment (str) – Name of App Service Environment where app or App Service plan should be created.
- is_xenon (bool) – <code>true</code> if App Service plan is running as a windows container
-
class
azure.mgmt.web.models.
ValidateResponseError
(*, code: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error details for when validation fails.
Parameters: - code (str) – Validation error code.
- message (str) – Validation error message.
-
class
azure.mgmt.web.models.
ValidateResponse
(*, status: str = None, error=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the result of resource validation.
Parameters: - status (str) – Result of validation.
- error (ValidateResponseError) – Error details for the case when validation fails.
-
class
azure.mgmt.web.models.
VnetParameters
(*, kind: str = None, vnet_resource_group: str = None, vnet_name: str = None, vnet_subnet_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
The required set of inputs to validate a VNET.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- vnet_resource_group (str) – The Resource Group of the VNET to be validated
- vnet_name (str) – The name of the VNET to be validated
- vnet_subnet_name (str) – The subnet name to be validated
-
class
azure.mgmt.web.models.
VnetValidationTestFailure
(*, kind: str = None, test_name: str = None, details: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A class that describes a test that failed during NSG and UDR validation.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- test_name (str) – The name of the test that failed.
- details (str) – The details of what caused the failure, e.g. the blocking rule name, etc.
-
class
azure.mgmt.web.models.
VnetValidationFailureDetails
(*, kind: str = None, failed: bool = None, failed_tests=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A class that describes the reason for a validation failure.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- failed (bool) – A flag describing whether or not validation failed.
- failed_tests (list[VnetValidationTestFailure]) – A list of tests that failed in the validation.
-
class
azure.mgmt.web.models.
FileSystemApplicationLogsConfig
(*, level='Off', **kwargs)[source]¶ Bases:
msrest.serialization.Model
Application logs to file system configuration.
Parameters: level (str or LogLevel) – Log level. Possible values include: ‘Off’, ‘Verbose’, ‘Information’, ‘Warning’, ‘Error’. Default value: “Off” .
-
class
azure.mgmt.web.models.
AzureTableStorageApplicationLogsConfig
(*, sas_url: str, level=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Application logs to Azure table storage configuration.
All required parameters must be populated in order to send to Azure.
Parameters: - level (str or LogLevel) – Log level. Possible values include: ‘Off’, ‘Verbose’, ‘Information’, ‘Warning’, ‘Error’
- sas_url (str) – Required. SAS URL to an Azure table with add/query/delete permissions.
-
class
azure.mgmt.web.models.
AzureBlobStorageApplicationLogsConfig
(*, level=None, sas_url: str = None, retention_in_days: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Application logs azure blob storage configuration.
Parameters: - level (str or LogLevel) – Log level. Possible values include: ‘Off’, ‘Verbose’, ‘Information’, ‘Warning’, ‘Error’
- sas_url (str) – SAS url to a azure blob container with read/write/list/delete permissions.
- retention_in_days (int) – Retention in days. Remove blobs older than X days. 0 or lower means no retention.
-
class
azure.mgmt.web.models.
ApplicationLogsConfig
(*, file_system=None, azure_table_storage=None, azure_blob_storage=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Application logs configuration.
Parameters: - file_system (FileSystemApplicationLogsConfig) – Application logs to file system configuration.
- azure_table_storage (AzureTableStorageApplicationLogsConfig) – Application logs to azure table storage configuration.
- azure_blob_storage (AzureBlobStorageApplicationLogsConfig) – Application logs to blob storage configuration.
-
class
azure.mgmt.web.models.
AzureBlobStorageHttpLogsConfig
(*, sas_url: str = None, retention_in_days: int = None, enabled: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Http logs to azure blob storage configuration.
Parameters: - sas_url (str) – SAS url to a azure blob container with read/write/list/delete permissions.
- retention_in_days (int) – Retention in days. Remove blobs older than X days. 0 or lower means no retention.
- enabled (bool) – True if configuration is enabled, false if it is disabled and null if configuration is not set.
-
class
azure.mgmt.web.models.
AzureStoragePropertyDictionaryResource
(*, kind: str = None, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
AzureStorageInfo dictionary resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- properties (dict[str, AzureStorageInfoValue]) – Azure storage accounts.
-
class
azure.mgmt.web.models.
DatabaseBackupSetting
(*, database_type, name: str = None, connection_string_name: str = None, connection_string: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Database backup settings.
All required parameters must be populated in order to send to Azure.
Parameters: - database_type (str or DatabaseType) – Required. Database type (e.g. SqlAzure / MySql). Possible values include: ‘SqlAzure’, ‘MySql’, ‘LocalMySql’, ‘PostgreSql’
- name (str) –
- connection_string_name (str) – Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
- connection_string (str) – Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
-
class
azure.mgmt.web.models.
BackupItem
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Backup description.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- backup_id (int) – Id of the backup.
- storage_account_url (str) – SAS URL for the storage account container which contains this backup.
- blob_name (str) – Name of the blob which contains data for this backup.
- backup_item_name (str) – Name of this backup.
- status (str or BackupItemStatus) – Backup status. Possible values include: ‘InProgress’, ‘Failed’, ‘Succeeded’, ‘TimedOut’, ‘Created’, ‘Skipped’, ‘PartiallySucceeded’, ‘DeleteInProgress’, ‘DeleteFailed’, ‘Deleted’
- size_in_bytes (long) – Size of the backup in bytes.
- created (datetime) – Timestamp of the backup creation.
- log (str) – Details regarding this backup. Might contain an error message.
- databases (list[DatabaseBackupSetting]) – List of databases included in the backup.
- scheduled (bool) – True if this backup has been created due to a schedule being triggered.
- last_restore_time_stamp (datetime) – Timestamp of a last restore operation which used this backup.
- finished_time_stamp (datetime) – Timestamp when this backup finished.
- correlation_id (str) – Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
- website_size_in_bytes (long) – Size of the original web app which has been backed up.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
BackupSchedule
(*, frequency_interval: int = 7, frequency_unit='Day', keep_at_least_one_backup: bool = True, retention_period_in_days: int = 30, start_time=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Parameters: - frequency_interval (int) – Required. How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day). Default value: 7 .
- frequency_unit (str or FrequencyUnit) – Required. The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7). Possible values include: ‘Day’, ‘Hour’. Default value: “Day” .
- keep_at_least_one_backup (bool) – Required. True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. Default value: True .
- retention_period_in_days (int) – Required. After how many days backups should be deleted. Default value: 30 .
- start_time (datetime) – When the schedule should start working.
Variables: last_execution_time (datetime) – Last time when this schedule was triggered.
-
class
azure.mgmt.web.models.
BackupRequest
(*, storage_account_url: str, kind: str = None, backup_name: str = None, enabled: bool = None, backup_schedule=None, databases=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Description of a backup which will be performed.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Variables: Parameters: - kind (str) – Kind of resource.
- backup_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) – Required. SAS URL to the container.
- backup_schedule (BackupSchedule) – Schedule for the backup if it is executed periodically.
- databases (list[DatabaseBackupSetting]) – Databases included in the backup.
-
class
azure.mgmt.web.models.
ConnStringValueTypePair
(*, value: str, type, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Database connection string value to type pair.
All required parameters must be populated in order to send to Azure.
Parameters: - value (str) – Required. Value of pair.
- type (str or ConnectionStringType) – Required. Type of database. Possible values include: ‘MySql’, ‘SQLServer’, ‘SQLAzure’, ‘Custom’, ‘NotificationHub’, ‘ServiceBus’, ‘EventHub’, ‘ApiHub’, ‘DocDb’, ‘RedisCache’, ‘PostgreSQL’
-
class
azure.mgmt.web.models.
ConnectionStringDictionary
(*, kind: str = None, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
String dictionary resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- properties (dict[str, ConnStringValueTypePair]) – Connection strings.
-
class
azure.mgmt.web.models.
ContinuousWebJob
(*, kind: str = None, status=None, detailed_status: str = None, log_url: str = None, run_command: str = None, url: str = None, extra_info_url: str = None, web_job_type=None, error: str = None, using_sdk: bool = None, settings=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Continuous Web Job Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- status (str or ContinuousWebJobStatus) – Job status. Possible values include: ‘Initializing’, ‘Starting’, ‘Running’, ‘PendingRestart’, ‘Stopped’
- detailed_status (str) – Detailed status.
- log_url (str) – Log URL.
- run_command (str) – Run command.
- url (str) – Job URL.
- extra_info_url (str) – Extra Info URL.
- web_job_type (str or WebJobType) – Job type. Possible values include: ‘Continuous’, ‘Triggered’
- error (str) – Error information.
- using_sdk (bool) – Using SDK?
- settings (dict[str, object]) – Job settings.
-
class
azure.mgmt.web.models.
CsmPublishingProfileOptions
(*, format=None, include_disaster_recovery_endpoints: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Publishing options for requested profile.
Parameters: - format (str or PublishingProfileFormat) – Name of the format. Valid values are: FileZilla3 WebDeploy – default Ftp. Possible values include: ‘FileZilla3’, ‘WebDeploy’, ‘Ftp’
- include_disaster_recovery_endpoints (bool) – Include the DisasterRecover endpoint if true
-
class
azure.mgmt.web.models.
CsmSlotEntity
(*, target_slot: str, preserve_vnet: bool, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Deployment slot parameters.
All required parameters must be populated in order to send to Azure.
Parameters: - target_slot (str) – Required. Destination deployment slot during swap operation.
- preserve_vnet (bool) – Required. <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>.
-
class
azure.mgmt.web.models.
CustomHostnameAnalysisResult
(*, kind: str = None, c_name_records=None, txt_records=None, a_records=None, alternate_cname_records=None, alternate_txt_records=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Custom domain analysis.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- is_hostname_already_verified (bool) – <code>true</code> if hostname is already verified; otherwise, <code>false</code>.
- custom_domain_verification_test (str or DnsVerificationTestResult) – DNS verification test result. Possible values include: ‘Passed’, ‘Failed’, ‘Skipped’
- custom_domain_verification_failure_info (ErrorEntity) – Raw failure information if DNS verification fails.
- has_conflict_on_scale_unit (bool) – <code>true</code> if there is a conflict on a scale unit; otherwise, <code>false</code>.
- has_conflict_across_subscription (bool) – <code>true</code> if htere is a conflict across subscriptions; otherwise, <code>false</code>.
- conflicting_app_resource_id (str) – Name of the conflicting app on scale unit if it’s within the same subscription.
Parameters: - kind (str) – Kind of resource.
- c_name_records (list[str]) – CName records controller can see for this hostname.
- txt_records (list[str]) – TXT records controller can see for this hostname.
- a_records (list[str]) – A records controller can see for this hostname.
- alternate_cname_records (list[str]) – Alternate CName records controller can see for this hostname.
- alternate_txt_records (list[str]) – Alternate TXT records controller can see for this hostname.
-
class
azure.mgmt.web.models.
DeletedAppRestoreRequest
(*, kind: str = None, deleted_site_id: str = None, recover_configuration: bool = None, snapshot_time: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Details about restoring a deleted app.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- deleted_site_id (str) – ARM resource ID of the deleted app. Example: /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
- recover_configuration (bool) – If true, deleted site configuration, in addition to content, will be restored.
- snapshot_time (str) – Point in time to restore the deleted app from, formatted as a DateTime string. If unspecified, default value is the time that the app was deleted.
-
class
azure.mgmt.web.models.
Deployment
(*, kind: str = None, status: int = None, message: str = None, author: str = None, deployer: str = None, author_email: str = None, start_time=None, end_time=None, active: bool = None, details: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
User crendentials used for publishing activity.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- status (int) – Deployment status.
- message (str) – Details about deployment status.
- author (str) – Who authored the deployment.
- deployer (str) – Who performed the deployment.
- author_email (str) – Author email.
- start_time (datetime) – Start time.
- end_time (datetime) – End time.
- active (bool) – True if deployment is currently active, false if completed and null if not started.
- details (str) – Details on deployment.
-
class
azure.mgmt.web.models.
EnabledConfig
(*, enabled: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Enabled configuration.
Parameters: enabled (bool) – True if configuration is enabled, false if it is disabled and null if configuration is not set.
-
class
azure.mgmt.web.models.
FileSystemHttpLogsConfig
(*, retention_in_mb: int = None, retention_in_days: int = None, enabled: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Http logs to file system configuration.
Parameters: - retention_in_mb (int) – Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100.
- retention_in_days (int) – Retention in days. Remove files older than X days. 0 or lower means no retention.
- enabled (bool) – True if configuration is enabled, false if it is disabled and null if configuration is not set.
-
class
azure.mgmt.web.models.
FunctionEnvelope
(*, kind: str = None, function_app_id: str = None, script_root_path_href: str = None, script_href: str = None, config_href: str = None, secrets_file_href: str = None, href: str = None, config=None, files=None, test_data: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Web Job Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- function_app_id (str) – Function App ID.
- script_root_path_href (str) – Script root path URI.
- script_href (str) – Script URI.
- config_href (str) – Config URI.
- secrets_file_href (str) – Secrets file URI.
- href (str) – Function URI.
- config (object) – Config information.
- files (dict[str, str]) – File list.
- test_data (str) – Test data used when testing via the Azure Portal.
-
class
azure.mgmt.web.models.
FunctionSecrets
(*, kind: str = None, key: str = None, trigger_url: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Function secrets.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- key (str) – Secret key.
- trigger_url (str) – Trigger URL.
-
class
azure.mgmt.web.models.
HostNameBinding
(*, kind: str = None, site_name: str = None, domain_id: str = None, azure_resource_name: str = None, azure_resource_type=None, custom_host_name_dns_record_type=None, host_name_type=None, ssl_state=None, thumbprint: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A hostname binding object.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- site_name (str) – App Service app name.
- domain_id (str) – Fully qualified ARM domain resource URI.
- azure_resource_name (str) – Azure resource name.
- azure_resource_type (str or AzureResourceType) – Azure resource type. Possible values include: ‘Website’, ‘TrafficManager’
- custom_host_name_dns_record_type (str or CustomHostNameDnsRecordType) – Custom DNS record type. Possible values include: ‘CName’, ‘A’
- host_name_type (str or HostNameType) – Hostname type. Possible values include: ‘Verified’, ‘Managed’
- ssl_state (str or SslState) – SSL type. Possible values include: ‘Disabled’, ‘SniEnabled’, ‘IpBasedEnabled’
- thumbprint (str) – SSL certificate thumbprint
-
class
azure.mgmt.web.models.
HttpLogsConfig
(*, file_system=None, azure_blob_storage=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Http logs configuration.
Parameters: - file_system (FileSystemHttpLogsConfig) – Http logs to file system configuration.
- azure_blob_storage (AzureBlobStorageHttpLogsConfig) – Http logs to azure blob storage configuration.
-
class
azure.mgmt.web.models.
MSDeploy
(*, kind: str = None, package_uri: str = None, connection_string: str = None, db_type: str = None, set_parameters_xml_file_uri: str = None, set_parameters=None, skip_app_data: bool = None, app_offline: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
MSDeploy ARM PUT information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- package_uri (str) – Package URI
- connection_string (str) – SQL Connection String
- db_type (str) – Database Type
- set_parameters_xml_file_uri (str) – URI of MSDeploy Parameters file. Must not be set if SetParameters is used.
- set_parameters (dict[str, str]) – MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.
- skip_app_data (bool) – Controls whether the MSDeploy operation skips the App_Data directory. If set to <code>true</code>, the existing App_Data directory on the destination will not be deleted, and any App_Data directory in the source will be ignored. Setting is <code>false</code> by default.
- app_offline (bool) – Sets the AppOffline rule while the MSDeploy operation executes. Setting is <code>false</code> by default.
-
class
azure.mgmt.web.models.
MSDeployLogEntry
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
MSDeploy log entry.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - time (datetime) – Timestamp of log entry
- type (str or MSDeployLogEntryType) – Log entry type. Possible values include: ‘Message’, ‘Warning’, ‘Error’
- message (str) – Log entry message
-
class
azure.mgmt.web.models.
MSDeployLog
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
MSDeploy log.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- entries (list[MSDeployLogEntry]) – List of log entry messages
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
MSDeployStatus
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
MSDeploy ARM response.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- deployer (str) – Username of deployer
- provisioning_state (str or MSDeployProvisioningState) – Provisioning state. Possible values include: ‘accepted’, ‘running’, ‘succeeded’, ‘failed’, ‘canceled’
- start_time (datetime) – Start time of deploy operation
- end_time (datetime) – End time of deploy operation
- complete (bool) – Whether the deployment operation has completed
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
MigrateMySqlRequest
(*, connection_string: str, migration_type, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
MySQL migration request.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Variables: Parameters: - kind (str) – Kind of resource.
- connection_string (str) – Required. Connection string to the remote MySQL database.
- migration_type (str or MySqlMigrationType) – Required. The type of migration operation to be done. Possible values include: ‘LocalToRemote’, ‘RemoteToLocal’
-
class
azure.mgmt.web.models.
MigrateMySqlStatus
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
MySQL migration status.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- migration_operation_status (str or OperationStatus) – Status of the migration task. Possible values include: ‘InProgress’, ‘Failed’, ‘Succeeded’, ‘TimedOut’, ‘Created’
- operation_id (str) – Operation ID for the migration task.
- local_my_sql_enabled (bool) – True if the web app has in app MySql enabled
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
RelayServiceConnectionEntity
(*, kind: str = None, entity_name: str = None, entity_connection_string: str = None, resource_type: str = None, resource_connection_string: str = None, hostname: str = None, port: int = None, biztalk_uri: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Hybrid Connection for an App Service app.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- entity_name (str) –
- entity_connection_string (str) –
- resource_type (str) –
- resource_connection_string (str) –
- hostname (str) –
- port (int) –
- biztalk_uri (str) –
-
class
azure.mgmt.web.models.
NetworkFeatures
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Full view of network features for an app (presently VNET integration and Hybrid Connections).
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- virtual_network_name (str) – The Virtual Network name.
- virtual_network_connection (VnetInfo) – The Virtual Network summary view.
- hybrid_connections (list[RelayServiceConnectionEntity]) – The Hybrid Connections summary view.
- hybrid_connections_v2 (list[HybridConnection]) – The Hybrid Connection V2 (Service Bus) view.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
PerfMonSample
(*, time=None, instance_name: str = None, value: float = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Performance monitor sample in a set.
Parameters: - time (datetime) – Point in time for which counter was measured.
- instance_name (str) – Name of the server on which the measurement is made.
- value (float) – Value of counter at a certain time.
-
class
azure.mgmt.web.models.
PerfMonSet
(*, name: str = None, start_time=None, end_time=None, time_grain: str = None, values=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Metric information.
Parameters: - name (str) – Unique key name of the counter.
- start_time (datetime) – Start time of the period.
- end_time (datetime) – End time of the period.
- time_grain (str) – Presented time grain.
- values (list[PerfMonSample]) – Collection of workers that are active during this time.
-
class
azure.mgmt.web.models.
PerfMonResponse
(*, code: str = None, message: str = None, data=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Performance monitor API response.
Parameters: - code (str) – The response code.
- message (str) – The message.
- data (PerfMonSet) – The performance monitor counters.
-
class
azure.mgmt.web.models.
PremierAddOn
(*, location: str, kind: str = None, tags=None, sku: str = None, product: str = None, vendor: str = None, marketplace_publisher: str = None, marketplace_offer: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.resource_py3.Resource
Premier add-on.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Variables: Parameters: - kind (str) – Kind of resource.
- location (str) – Required. Resource Location.
- tags (dict[str, str]) – Resource tags.
- sku (str) – Premier add on SKU.
- product (str) – Premier add on Product.
- vendor (str) – Premier add on Vendor.
- marketplace_publisher (str) – Premier add on Marketplace publisher.
- marketplace_offer (str) – Premier add on Marketplace offer.
-
class
azure.mgmt.web.models.
PremierAddOnPatchResource
(*, kind: str = None, sku: str = None, product: str = None, vendor: str = None, marketplace_publisher: str = None, marketplace_offer: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
ARM resource for a PremierAddOn.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- sku (str) – Premier add on SKU.
- product (str) – Premier add on Product.
- vendor (str) – Premier add on Vendor.
- marketplace_publisher (str) – Premier add on Marketplace publisher.
- marketplace_offer (str) – Premier add on Marketplace offer.
-
class
azure.mgmt.web.models.
PrivateAccessSubnet
(*, name: str = None, key: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Description of a Virtual Network subnet that is useable for private site access.
Parameters: - name (str) – The name of the subnet.
- key (int) – The key (ID) of the subnet.
-
class
azure.mgmt.web.models.
PrivateAccessVirtualNetwork
(*, name: str = None, key: int = None, resource_id: str = None, subnets=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Description of a Virtual Network that is useable for private site access.
Parameters: - name (str) – The name of the Virtual Network.
- key (int) – The key (ID) of the Virtual Network.
- resource_id (str) – The ARM uri of the Virtual Network
- subnets (list[PrivateAccessSubnet]) – A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.
-
class
azure.mgmt.web.models.
PrivateAccess
(*, kind: str = None, enabled: bool = None, virtual_networks=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Description of the parameters of Private Access for a Web Site.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- enabled (bool) – Whether private access is enabled or not.
- virtual_networks (list[PrivateAccessVirtualNetwork]) – The Virtual Networks (and subnets) allowed to access the site privately.
-
class
azure.mgmt.web.models.
ProcessThreadInfo
(*, kind: str = None, href: str = None, process: str = None, start_address: str = None, current_priority: int = None, priority_level: str = None, base_priority: int = None, start_time=None, total_processor_time: str = None, user_processor_time: str = None, priviledged_processor_time: str = None, state: str = None, wait_reason: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Process Thread Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- href (str) – HRef URI.
- process (str) – Process URI.
- start_address (str) – Start address.
- current_priority (int) – Current thread priority.
- priority_level (str) – Thread priority level.
- base_priority (int) – Base priority.
- start_time (datetime) – Start time.
- total_processor_time (str) – Total processor time.
- user_processor_time (str) – User processor time.
- priviledged_processor_time (str) – Priviledged processor time.
- state (str) – Thread state.
- wait_reason (str) – Wait reason.
-
class
azure.mgmt.web.models.
ProcessModuleInfo
(*, kind: str = None, base_address: str = None, file_name: str = None, href: str = None, file_path: str = None, module_memory_size: int = None, file_version: str = None, file_description: str = None, product: str = None, product_version: str = None, is_debug: bool = None, language: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Process Module Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- base_address (str) – Base address. Used as module identifier in ARM resource URI.
- file_name (str) – File name.
- href (str) – HRef URI.
- file_path (str) – File path.
- module_memory_size (int) – Module memory size.
- file_version (str) – File version.
- file_description (str) – File description.
- product (str) – Product name.
- product_version (str) – Product version.
- is_debug (bool) – Is debug?
- language (str) – Module language (locale).
-
class
azure.mgmt.web.models.
ProcessInfo
(*, kind: str = None, deployment_name: str = None, href: str = None, minidump: str = None, is_profile_running: bool = None, is_iis_profile_running: bool = None, iis_profile_timeout_in_seconds: float = None, parent: str = None, children=None, threads=None, open_file_handles=None, modules=None, file_name: str = None, command_line: str = None, user_name: str = None, handle_count: int = None, module_count: int = None, thread_count: int = None, start_time=None, total_cpu_time: str = None, user_cpu_time: str = None, privileged_cpu_time: str = None, working_set: int = None, peak_working_set: int = None, private_memory: int = None, virtual_memory: int = None, peak_virtual_memory: int = None, paged_system_memory: int = None, non_paged_system_memory: int = None, paged_memory: int = None, peak_paged_memory: int = None, time_stamp=None, environment_variables=None, is_scm_site: bool = None, is_webjob: bool = None, description: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Process Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- deployment_name (str) – Deployment name.
- href (str) – HRef URI.
- minidump (str) – Minidump URI.
- is_profile_running (bool) – Is profile running?
- is_iis_profile_running (bool) – Is the IIS Profile running?
- iis_profile_timeout_in_seconds (float) – IIS Profile timeout (seconds).
- parent (str) – Parent process.
- children (list[str]) – Child process list.
- threads (list[ProcessThreadInfo]) – Thread list.
- open_file_handles (list[str]) – List of open files.
- modules (list[ProcessModuleInfo]) – List of modules.
- file_name (str) – File name of this process.
- command_line (str) – Command line.
- user_name (str) – User name.
- handle_count (int) – Handle count.
- module_count (int) – Module count.
- thread_count (int) – Thread count.
- start_time (datetime) – Start time.
- total_cpu_time (str) – Total CPU time.
- user_cpu_time (str) – User CPU time.
- privileged_cpu_time (str) – Privileged CPU time.
- working_set (long) – Working set.
- peak_working_set (long) – Peak working set.
- private_memory (long) – Private memory size.
- virtual_memory (long) – Virtual memory size.
- peak_virtual_memory (long) – Peak virtual memory usage.
- paged_system_memory (long) – Paged system memory.
- non_paged_system_memory (long) – Non-paged system memory.
- paged_memory (long) – Paged memory.
- peak_paged_memory (long) – Peak paged memory.
- time_stamp (datetime) – Time stamp.
- environment_variables (dict[str, str]) – List of environment variables.
- is_scm_site (bool) – Is this the SCM site?
- is_webjob (bool) – Is this a Web Job?
- description (str) – Description of process.
-
class
azure.mgmt.web.models.
PublicCertificate
(*, kind: str = None, blob: bytearray = None, public_certificate_location=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Public certificate object.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- blob (bytearray) – Public Certificate byte array
- public_certificate_location (str or PublicCertificateLocation) – Public Certificate Location. Possible values include: ‘CurrentUserMy’, ‘LocalMachineMy’, ‘Unknown’
-
class
azure.mgmt.web.models.
RestoreRequest
(*, storage_account_url: str, overwrite: bool, kind: str = None, blob_name: str = None, site_name: str = None, databases=None, ignore_conflicting_host_names: bool = False, ignore_databases: bool = False, app_service_plan: str = None, operation_type='Default', adjust_connection_strings: bool = None, hosting_environment: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Description of a restore request.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Variables: Parameters: - kind (str) – Kind of resource.
- storage_account_url (str) – Required. SAS URL to the container.
- blob_name (str) – Name of a blob which contains the backup.
- overwrite (bool) – Required. <code>true</code> if the restore operation can overwrite target app; otherwise, <code>false</code>. <code>true</code> is needed if trying to restore over an existing app.
- site_name (str) – Name of an app.
- databases (list[DatabaseBackupSetting]) – Collection of databases which should be restored. This list has to match the list of databases included in the backup.
- ignore_conflicting_host_names (bool) – Changes a logic when restoring an app with custom domains. <code>true</code> to remove custom domains automatically. If <code>false</code>, custom domains are added to the app’s object when it is being restored, but that might fail due to conflicts during the operation. Default value: False .
- ignore_databases (bool) – Ignore the databases and only restore the site content. Default value: False .
- app_service_plan (str) – Specify app service plan that will own restored site.
- operation_type (str or BackupRestoreOperationType) – Operation type. Possible values include: ‘Default’, ‘Clone’, ‘Relocation’, ‘Snapshot’, ‘CloudFS’. Default value: “Default” .
- adjust_connection_strings (bool) – <code>true</code> if SiteConfig.ConnectionStrings should be set in new app; otherwise, <code>false</code>.
- hosting_environment (str) – App Service Environment name, if needed (only when restoring an app to an App Service Environment).
-
class
azure.mgmt.web.models.
SiteAuthSettings
(*, kind: str = None, enabled: bool = None, runtime_version: str = None, unauthenticated_client_action=None, token_store_enabled: bool = None, allowed_external_redirect_urls=None, default_provider=None, token_refresh_extension_hours: float = None, client_id: str = None, client_secret: str = None, issuer: str = None, validate_issuer: bool = None, allowed_audiences=None, additional_login_params=None, google_client_id: str = None, google_client_secret: str = None, google_oauth_scopes=None, facebook_app_id: str = None, facebook_app_secret: str = None, facebook_oauth_scopes=None, twitter_consumer_key: str = None, twitter_consumer_secret: str = None, microsoft_account_client_id: str = None, microsoft_account_client_secret: str = None, microsoft_account_oauth_scopes=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Configuration settings for the Azure App Service Authentication / Authorization feature.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- enabled (bool) – <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
- runtime_version (str) – The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.
- unauthenticated_client_action (str or UnauthenticatedClientAction) – The action to take when an unauthenticated client attempts to access the app. Possible values include: ‘RedirectToLoginPage’, ‘AllowAnonymous’
- token_store_enabled (bool) – <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>. The default is <code>false</code>.
- allowed_external_redirect_urls (list[str]) – External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.
- default_provider (str or BuiltInAuthenticationProvider) – The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to “RedirectToLoginPage”. Possible values include: ‘AzureActiveDirectory’, ‘Facebook’, ‘Google’, ‘MicrosoftAccount’, ‘Twitter’
- token_refresh_extension_hours (float) – The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
- client_id (str) – The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
- client_secret (str) – The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
- issuer (str) – The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
- validate_issuer (bool) – Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
- allowed_audiences (list[str]) – Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the <code>ClientID</code> value is always considered an allowed audience, regardless of this setting.
- additional_login_params (list[str]) – Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.
- google_client_id (str) – The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google_client_secret (str) – The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- google_oauth_scopes (list[str]) – The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, “openid”, “profile”, and “email” are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
- facebook_app_id (str) – The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook_app_secret (str) – The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- facebook_oauth_scopes (list[str]) – The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
- twitter_consumer_key (str) – The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- twitter_consumer_secret (str) – The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
- microsoft_account_client_id (str) – The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft_account_client_secret (str) – The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
- microsoft_account_oauth_scopes (list[str]) – The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, “wl.basic” is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx
-
class
azure.mgmt.web.models.
SiteCloneabilityCriterion
(*, name: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An app cloneability criterion.
Parameters: - name (str) – Name of criterion.
- description (str) – Description of criterion.
-
class
azure.mgmt.web.models.
SiteCloneability
(*, result=None, blocking_features=None, unsupported_features=None, blocking_characteristics=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Represents whether or not an app is cloneable.
Parameters: - result (str or CloneAbilityResult) – Name of app. Possible values include: ‘Cloneable’, ‘PartiallyCloneable’, ‘NotCloneable’
- blocking_features (list[SiteCloneabilityCriterion]) – List of features enabled on app that prevent cloning.
- unsupported_features (list[SiteCloneabilityCriterion]) – List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned but the features in this list will not be set up on cloned app.
- blocking_characteristics (list[SiteCloneabilityCriterion]) – List of blocking application characteristics.
-
class
azure.mgmt.web.models.
SiteConfigResource
(*, kind: str = None, number_of_workers: int = None, default_documents=None, net_framework_version: str = 'v4.6', php_version: str = None, python_version: str = None, node_version: str = None, linux_fx_version: str = None, windows_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, azure_storage_accounts=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, managed_service_identity_id: int = None, x_managed_service_identity_id: int = None, ip_security_restrictions=None, http20_enabled: bool = True, min_tls_version=None, ftps_state=None, reserved_instance_count: int = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Web app configuration ARM resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- machine_key (SiteMachineKey) – Site MachineKey.
Parameters: - kind (str) – Kind of resource.
- number_of_workers (int) – Number of workers.
- default_documents (list[str]) – Default documents.
- net_framework_version (str) – .NET Framework version. Default value: “v4.6” .
- php_version (str) – Version of PHP.
- python_version (str) – Version of Python.
- node_version (str) – Version of Node.js.
- linux_fx_version (str) – Linux App Framework and version
- windows_fx_version (str) – Xenon 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.
- azure_storage_accounts (dict[str, AzureStorageInfoValue]) – User-provided Azure storage accounts.
- 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 polymophic types.
- limits (SiteLimits) – Site limits.
- auto_heal_enabled (bool) – <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>.
- auto_heal_rules (AutoHealRules) – Auto Heal rules.
- tracing_options (str) – Tracing options.
- vnet_name (str) – Virtual Network name.
- cors (CorsSettings) – Cross-Origin Resource Sharing (CORS) settings.
- push (PushSettings) – Push endpoint settings.
- api_definition (ApiDefinitionInfo) – Information about the formal API definition for the app.
- auto_swap_slot_name (str) – Auto-swap slot name.
- local_my_sql_enabled (bool) – <code>true</code> to enable local MySQL; otherwise, <code>false</code>. Default value: False .
- managed_service_identity_id (int) – Managed Service Identity Id
- x_managed_service_identity_id (int) – Explicit Managed Service Identity Id
- 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’
- ftps_state (str or FtpsState) – State of FTP / FTPS service. Possible values include: ‘AllAllowed’, ‘FtpsOnly’, ‘Disabled’
- reserved_instance_count (int) – Number of reserved instances. This setting only applies to the Consumption Plan
-
class
azure.mgmt.web.models.
SiteConfigurationSnapshotInfo
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A snapshot of a web app configuration.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
SiteExtensionInfo
(*, kind: str = None, extension_id: str = None, title: str = None, extension_type=None, summary: str = None, description: str = None, version: str = None, extension_url: str = None, project_url: str = None, icon_url: str = None, license_url: str = None, feed_url: str = None, authors=None, installer_command_line_params: str = None, published_date_time=None, download_count: int = None, local_is_latest_version: bool = None, local_path: str = None, installed_date_time=None, provisioning_state: str = None, comment: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Site Extension Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- extension_id (str) – Site extension ID.
- title (str) –
- extension_type (str or SiteExtensionType) – Site extension type. Possible values include: ‘Gallery’, ‘WebRoot’
- summary (str) – Summary description.
- description (str) – Detailed description.
- version (str) – Version information.
- extension_url (str) – Extension URL.
- project_url (str) – Project URL.
- icon_url (str) – Icon URL.
- license_url (str) – License URL.
- feed_url (str) – Feed URL.
- authors (list[str]) – List of authors.
- installer_command_line_params (str) – Installer command line parameters.
- published_date_time (datetime) – Published timestamp.
- download_count (int) – Count of downloads.
- local_is_latest_version (bool) – <code>true</code> if the local version is the latest version; <code>false</code> otherwise.
- local_path (str) – Local path.
- installed_date_time (datetime) – Installed timestamp.
- provisioning_state (str) – Provisioning state.
- comment (str) – Site Extension comment.
-
class
azure.mgmt.web.models.
SiteInstance
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Instance of an app.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
SiteLogsConfig
(*, kind: str = None, application_logs=None, http_logs=None, failed_requests_tracing=None, detailed_error_messages=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Configuration of App Service site logs.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- application_logs (ApplicationLogsConfig) – Application logs configuration.
- http_logs (HttpLogsConfig) – HTTP logs configuration.
- failed_requests_tracing (EnabledConfig) – Failed requests tracing configuration.
- detailed_error_messages (EnabledConfig) – Detailed error messages configuration.
-
class
azure.mgmt.web.models.
SitePatchResource
(*, kind: str = None, enabled: bool = None, host_name_ssl_states=None, server_farm_id: str = None, reserved: bool = False, is_xenon: bool = False, hyper_v: 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, https_only: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
ARM resource for a site.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- state (str) – Current state of the app.
- host_names (list[str]) – Hostnames associated with the app.
- repository_site_name (str) – Name of the repository site.
- usage_state (str or UsageState) – State indicating whether the app has exceeded its quota usage. Read-only. Possible values include: ‘Normal’, ‘Exceeded’
- enabled_host_names (list[str]) – Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.
- availability_state (str or SiteAvailabilityState) – Management information availability state for the app. Possible values include: ‘Normal’, ‘Limited’, ‘DisasterRecoveryMode’
- last_modified_time_utc (datetime) – Last time the app was modified, in UTC. Read-only.
- traffic_manager_host_names (list[str]) – Azure Traffic Manager hostnames associated with the app. Read-only.
- target_swap_slot (str) – Specifies which deployment slot this app will swap into. Read-only.
- outbound_ip_addresses (str) – List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
- possible_outbound_ip_addresses (str) – List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
- suspended_till (datetime) – App suspended till in case memory-time quota is exceeded.
- max_number_of_workers (int) – Maximum number of workers. This only applies to Functions container.
- resource_group (str) – Name of the resource group the app belongs to. Read-only.
- is_default_container (bool) – <code>true</code> if the app is a default container; otherwise, <code>false</code>.
- default_host_name (str) – Default hostname of the app. Read-only.
- slot_swap_status (SlotSwapStatus) – Status of the last deployment slot swap operation.
Parameters: - kind (str) – Kind of resource.
- enabled (bool) – <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).
- host_name_ssl_states (list[HostNameSslState]) – Hostname SSL states are used to manage the SSL bindings for app’s hostnames.
- server_farm_id (str) – Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”.
- reserved (bool) – <code>true</code> if reserved; otherwise, <code>false</code>. Default value: False .
- is_xenon (bool) – Obsolete: Hyper-V sandbox. Default value: False .
- hyper_v (bool) – Hyper-V sandbox. 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.
- https_only (bool) – HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests
-
class
azure.mgmt.web.models.
SitePhpErrorLogFlag
(*, kind: str = None, local_log_errors: str = None, master_log_errors: str = None, local_log_errors_max_length: str = None, master_log_errors_max_length: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Used for getting PHP error logging flag.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- local_log_errors (str) – Local log_errors setting.
- master_log_errors (str) – Master log_errors setting.
- local_log_errors_max_length (str) – Local log_errors_max_len setting.
- master_log_errors_max_length (str) – Master log_errors_max_len setting.
-
class
azure.mgmt.web.models.
SiteSourceControl
(*, kind: str = None, repo_url: str = None, branch: str = None, is_manual_integration: bool = None, deployment_rollback_enabled: bool = None, is_mercurial: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Source control configuration for an app.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- repo_url (str) – Repository or source control URL.
- branch (str) – Name of branch to use for deployment.
- is_manual_integration (bool) – <code>true</code> to limit to manual integration; <code>false</code> to enable continuous integration (which configures webhooks into online repos like GitHub).
- deployment_rollback_enabled (bool) – <code>true</code> to enable deployment rollback; otherwise, <code>false</code>.
- is_mercurial (bool) – <code>true</code> for a Mercurial repository; <code>false</code> for a Git repository.
-
class
azure.mgmt.web.models.
SlotConfigNamesResource
(*, kind: str = None, connection_string_names=None, app_setting_names=None, azure_storage_config_names=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Slot Config names azure resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- connection_string_names (list[str]) – List of connection string names.
- app_setting_names (list[str]) – List of application settings names.
- azure_storage_config_names (list[str]) – List of external Azure storage account identifiers.
-
class
azure.mgmt.web.models.
SlotDifference
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
A setting difference between two deployment slots of an app.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- level (str) – Level of the difference: Information, Warning or Error.
- setting_type (str) – The type of the setting: General, AppSetting or ConnectionString.
- diff_rule (str) – Rule that describes how to process the setting difference during a slot swap.
- setting_name (str) – Name of the setting.
- value_in_current_slot (str) – Value of the setting in the current slot.
- value_in_target_slot (str) – Value of the setting in the target slot.
- description (str) – Description of the setting difference.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
SnapshotRecoverySource
(*, location: str = None, id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Specifies the web app that snapshot contents will be retrieved from.
Parameters: - location (str) – Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS
- id (str) – ARM resource ID of the source 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.models.
SnapshotRestoreRequest
(*, overwrite: bool, kind: str = None, snapshot_time: str = None, recovery_source=None, recover_configuration: bool = None, ignore_conflicting_host_names: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_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: Parameters: - kind (str) – Kind of resource.
- snapshot_time (str) – Point in time in which the app restore should be done, formatted as a DateTime string.
- recovery_source (SnapshotRecoverySource) – Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source.
- overwrite (bool) – Required. If <code>true</code> the restore 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.models.
StorageMigrationOptions
(*, azurefiles_connection_string: str, azurefiles_share: str, kind: str = None, switch_site_after_migration: bool = False, block_write_access_to_site: bool = False, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Options for app content migration.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Variables: Parameters: - kind (str) – Kind of resource.
- azurefiles_connection_string (str) – Required. AzureFiles connection string.
- azurefiles_share (str) – Required. AzureFiles share.
- switch_site_after_migration (bool) – <code>true</code>if the app should be switched over; otherwise, <code>false</code>. Default value: False .
- block_write_access_to_site (bool) – <code>true</code> if the app should be read only during copy operation; otherwise, <code>false</code>. Default value: False .
-
class
azure.mgmt.web.models.
StorageMigrationResponse
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Response for a migration of app content request.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
StringDictionary
(*, kind: str = None, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
String dictionary resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- properties (dict[str, str]) – Settings.
-
class
azure.mgmt.web.models.
SwiftVirtualNetwork
(*, kind: str = None, subnet_resource_id: str = None, swift_supported: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- subnet_resource_id (str) – The Virtual Network subnet’s resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.
- swift_supported (bool) – A flag that specifies if the scale unit this Web App is on supports Swift integration.
-
class
azure.mgmt.web.models.
TriggeredJobRun
(*, kind: str = None, web_job_id: str = None, web_job_name: str = None, status=None, start_time=None, end_time=None, duration: str = None, output_url: str = None, error_url: str = None, url: str = None, job_name: str = None, trigger: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Triggered Web Job Run Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- web_job_id (str) – Job ID.
- web_job_name (str) – Job name.
- status (str or TriggeredWebJobStatus) – Job status. Possible values include: ‘Success’, ‘Failed’, ‘Error’
- start_time (datetime) – Start time.
- end_time (datetime) – End time.
- duration (str) – Job duration.
- output_url (str) – Output URL.
- error_url (str) – Error URL.
- url (str) – Job URL.
- job_name (str) – Job name.
- trigger (str) – Job trigger.
-
class
azure.mgmt.web.models.
TriggeredJobHistory
(*, kind: str = None, runs=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Triggered Web Job History. List of Triggered Web Job Run Information elements.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- runs (list[TriggeredJobRun]) – List of triggered web job runs.
-
class
azure.mgmt.web.models.
TriggeredWebJob
(*, kind: str = None, latest_run=None, history_url: str = None, scheduler_logs_url: str = None, run_command: str = None, url: str = None, extra_info_url: str = None, web_job_type=None, error: str = None, using_sdk: bool = None, settings=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Triggered Web Job Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- latest_run (TriggeredJobRun) – Latest job run information.
- history_url (str) – History URL.
- scheduler_logs_url (str) – Scheduler Logs URL.
- run_command (str) – Run command.
- url (str) – Job URL.
- extra_info_url (str) – Extra Info URL.
- web_job_type (str or WebJobType) – Job type. Possible values include: ‘Continuous’, ‘Triggered’
- error (str) – Error information.
- using_sdk (bool) – Using SDK?
- settings (dict[str, object]) – Job settings.
-
class
azure.mgmt.web.models.
WebJob
(*, kind: str = None, run_command: str = None, url: str = None, extra_info_url: str = None, web_job_type=None, error: str = None, using_sdk: bool = None, settings=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Web Job Information.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- run_command (str) – Run command.
- url (str) – Job URL.
- extra_info_url (str) – Extra Info URL.
- web_job_type (str or WebJobType) – Job type. Possible values include: ‘Continuous’, ‘Triggered’
- error (str) – Error information.
- using_sdk (bool) – Using SDK?
- settings (dict[str, object]) – Job settings.
-
class
azure.mgmt.web.models.
AddressResponse
(*, service_ip_address: str = None, internal_ip_address: str = None, outbound_ip_addresses=None, vip_mappings=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes main public IP address and any extra virtual IPs.
Parameters: - service_ip_address (str) – Main public virtual IP.
- internal_ip_address (str) – Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.
- outbound_ip_addresses (list[str]) – IP addresses appearing on outbound connections.
- vip_mappings (list[VirtualIPMapping]) – Additional virtual IPs.
-
class
azure.mgmt.web.models.
AppServiceEnvironmentResource
(*, location: str, app_service_environment_resource_name: str, app_service_environment_resource_location: str, virtual_network, worker_pools, kind: str = None, tags=None, vnet_name: str = None, vnet_resource_group_name: str = None, vnet_subnet_name: str = None, internal_load_balancing_mode=None, multi_size: str = None, multi_role_count: int = None, ipssl_address_count: int = None, dns_suffix: str = None, network_access_control_list=None, front_end_scale_factor: int = None, api_management_account_id: str = None, suspended: bool = None, dynamic_cache_enabled: bool = None, cluster_settings=None, user_whitelisted_ip_ranges=None, has_linux_workers: bool = None, ssl_cert_key_vault_id: str = None, ssl_cert_key_vault_secret_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.resource_py3.Resource
App Service Environment ARM resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
- status (str or HostingEnvironmentStatus) – Current status of the App Service Environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’
- database_edition (str) – Edition of the metadata database for the App Service Environment, e.g. “Standard”.
- database_service_objective (str) – Service objective of the metadata database for the App Service Environment, e.g. “S0”.
- upgrade_domains (int) – Number of upgrade domains of the App Service Environment.
- subscription_id (str) – Subscription of the App Service Environment.
- last_action (str) – Last deployment action on the App Service Environment.
- last_action_result (str) – Result of the last deployment action on the App Service Environment.
- allowed_multi_sizes (str) – List of comma separated strings describing which VM sizes are allowed for front-ends.
- allowed_worker_sizes (str) – List of comma separated strings describing which VM sizes are allowed for workers.
- maximum_number_of_machines (int) – Maximum number of VMs in the App Service Environment.
- vip_mappings (list[VirtualIPMapping]) – Description of IP SSL mapping for the App Service Environment.
- environment_capacities (list[StampCapacity]) – Current total, used, and available worker capacities.
- environment_is_healthy (bool) – True/false indicating whether the App Service Environment is healthy.
- environment_status (str) – Detailed message about with results of the last check of the App Service Environment.
- resource_group (str) – Resource group of the App Service Environment.
- default_front_end_scale_factor (int) – Default Scale Factor for FrontEnds.
Parameters: - kind (str) – Kind of resource.
- location (str) – Required. Resource Location.
- tags (dict[str, str]) – Resource tags.
- app_service_environment_resource_name (str) – Required. Name of the App Service Environment.
- app_service_environment_resource_location (str) – Required. Location of the App Service Environment, e.g. “West US”.
- vnet_name (str) – Name of the Virtual Network for the App Service Environment.
- vnet_resource_group_name (str) – Resource group of the Virtual Network.
- vnet_subnet_name (str) – Subnet of the Virtual Network.
- virtual_network (VirtualNetworkProfile) – Required. Description of the Virtual Network.
- internal_load_balancing_mode (str or InternalLoadBalancingMode) – Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: ‘None’, ‘Web’, ‘Publishing’
- multi_size (str) – Front-end VM size, e.g. “Medium”, “Large”.
- multi_role_count (int) – Number of front-end instances.
- worker_pools (list[WorkerPool]) – Required. Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
- ipssl_address_count (int) – Number of IP SSL addresses reserved for the App Service Environment.
- dns_suffix (str) – DNS suffix of the App Service Environment.
- network_access_control_list (list[NetworkAccessControlEntry]) – Access control list for controlling traffic to the App Service Environment.
- front_end_scale_factor (int) – Scale factor for front-ends.
- api_management_account_id (str) – API Management Account associated with the App Service Environment.
- suspended (bool) – <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- dynamic_cache_enabled (bool) – True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- cluster_settings (list[NameValuePair]) – Custom settings for changing the behavior of the App Service Environment.
- user_whitelisted_ip_ranges (list[str]) – User added ip ranges to whitelist on ASE db
- has_linux_workers (bool) – Flag that displays whether an ASE has linux workers or not
- ssl_cert_key_vault_id (str) – Key Vault ID for ILB App Service Environment default SSL certificate
- ssl_cert_key_vault_secret_name (str) – Key Vault Secret Name for ILB App Service Environment default SSL certificate
-
class
azure.mgmt.web.models.
AppServiceEnvironmentPatchResource
(*, app_service_environment_patch_resource_name: str, location: str, virtual_network, worker_pools, kind: str = None, vnet_name: str = None, vnet_resource_group_name: str = None, vnet_subnet_name: str = None, internal_load_balancing_mode=None, multi_size: str = None, multi_role_count: int = None, ipssl_address_count: int = None, dns_suffix: str = None, network_access_control_list=None, front_end_scale_factor: int = None, api_management_account_id: str = None, suspended: bool = None, dynamic_cache_enabled: bool = None, cluster_settings=None, user_whitelisted_ip_ranges=None, has_linux_workers: bool = None, ssl_cert_key_vault_id: str = None, ssl_cert_key_vault_secret_name: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
ARM resource for a app service enviroment.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- provisioning_state (str or ProvisioningState) – Provisioning state of the App Service Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’
- status (str or HostingEnvironmentStatus) – Current status of the App Service Environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’
- database_edition (str) – Edition of the metadata database for the App Service Environment, e.g. “Standard”.
- database_service_objective (str) – Service objective of the metadata database for the App Service Environment, e.g. “S0”.
- upgrade_domains (int) – Number of upgrade domains of the App Service Environment.
- subscription_id (str) – Subscription of the App Service Environment.
- last_action (str) – Last deployment action on the App Service Environment.
- last_action_result (str) – Result of the last deployment action on the App Service Environment.
- allowed_multi_sizes (str) – List of comma separated strings describing which VM sizes are allowed for front-ends.
- allowed_worker_sizes (str) – List of comma separated strings describing which VM sizes are allowed for workers.
- maximum_number_of_machines (int) – Maximum number of VMs in the App Service Environment.
- vip_mappings (list[VirtualIPMapping]) – Description of IP SSL mapping for the App Service Environment.
- environment_capacities (list[StampCapacity]) – Current total, used, and available worker capacities.
- environment_is_healthy (bool) – True/false indicating whether the App Service Environment is healthy.
- environment_status (str) – Detailed message about with results of the last check of the App Service Environment.
- resource_group (str) – Resource group of the App Service Environment.
- default_front_end_scale_factor (int) – Default Scale Factor for FrontEnds.
Parameters: - kind (str) – Kind of resource.
- app_service_environment_patch_resource_name (str) – Required. Name of the App Service Environment.
- location (str) – Required. Location of the App Service Environment, e.g. “West US”.
- vnet_name (str) – Name of the Virtual Network for the App Service Environment.
- vnet_resource_group_name (str) – Resource group of the Virtual Network.
- vnet_subnet_name (str) – Subnet of the Virtual Network.
- virtual_network (VirtualNetworkProfile) – Required. Description of the Virtual Network.
- internal_load_balancing_mode (str or InternalLoadBalancingMode) – Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: ‘None’, ‘Web’, ‘Publishing’
- multi_size (str) – Front-end VM size, e.g. “Medium”, “Large”.
- multi_role_count (int) – Number of front-end instances.
- worker_pools (list[WorkerPool]) – Required. Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.
- ipssl_address_count (int) – Number of IP SSL addresses reserved for the App Service Environment.
- dns_suffix (str) – DNS suffix of the App Service Environment.
- network_access_control_list (list[NetworkAccessControlEntry]) – Access control list for controlling traffic to the App Service Environment.
- front_end_scale_factor (int) – Scale factor for front-ends.
- api_management_account_id (str) – API Management Account associated with the App Service Environment.
- suspended (bool) – <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- dynamic_cache_enabled (bool) – True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
- cluster_settings (list[NameValuePair]) – Custom settings for changing the behavior of the App Service Environment.
- user_whitelisted_ip_ranges (list[str]) – User added ip ranges to whitelist on ASE db
- has_linux_workers (bool) – Flag that displays whether an ASE has linux workers or not
- ssl_cert_key_vault_id (str) – Key Vault ID for ILB App Service Environment default SSL certificate
- ssl_cert_key_vault_secret_name (str) – Key Vault Secret Name for ILB App Service Environment default SSL certificate
-
class
azure.mgmt.web.models.
HostingEnvironmentDiagnostics
(*, name: str = None, diagnosics_output: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Diagnostics for an App Service Environment.
Parameters: - name (str) – Name/identifier of the diagnostics.
- diagnosics_output (str) – Diagnostics output.
-
class
azure.mgmt.web.models.
MetricAvailabilily
(*, time_grain: str = None, retention: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Metric availability and retention.
Parameters: - time_grain (str) – Time grain.
- retention (str) – Retention period for the current time grain.
-
class
azure.mgmt.web.models.
MetricDefinition
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Metadata for a metric.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- unit (str) – Unit of the metric.
- primary_aggregation_type (str) – Primary aggregation type.
- metric_availabilities (list[MetricAvailabilily]) – List of time grains supported for the metric together with retention period.
- display_name (str) – Friendly name shown in the UI.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
SkuInfo
(*, resource_type: str = None, sku=None, capacity=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
SKU discovery information.
Parameters: - resource_type (str) – Resource type that this SKU applies to.
- sku (SkuDescription) – Name and tier of the SKU.
- capacity (SkuCapacity) – Min, max, and default scale values of the SKU.
-
class
azure.mgmt.web.models.
Usage
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Usage of the quota resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - id (str) – Resource Id.
- name (str) – Resource Name.
- type (str) – Resource type.
- display_name (str) – Friendly name shown in the UI.
- resource_name (str) – Name of the quota resource.
- unit (str) – Units of measurement for the quota resource.
- current_value (long) – The current value of the resource counter.
- limit (long) – The resource limit.
- next_reset_time (datetime) – Next reset time for the resource counter.
- compute_mode (str or ComputeModeOptions) – Compute mode used for this usage. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
- site_mode (str) – Site mode used for this usage.
Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
WorkerPoolResource
(*, kind: str = None, worker_size_id: int = None, compute_mode=None, worker_size: str = None, worker_count: int = None, sku=None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Worker pool of an App Service Environment ARM resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- worker_size_id (int) – Worker size ID for referencing this worker pool.
- compute_mode (str or ComputeModeOptions) – Shared or dedicated app hosting. Possible values include: ‘Shared’, ‘Dedicated’, ‘Dynamic’
- worker_size (str) – VM size of the worker pool instances.
- worker_count (int) – Number of instances in the worker pool.
- sku (SkuDescription) –
-
class
azure.mgmt.web.models.
AppServicePlanPatchResource
(*, kind: str = None, worker_tier_name: str = None, admin_site_name: str = None, hosting_environment_profile=None, per_site_scaling: bool = False, is_spot: bool = None, spot_expiration_time=None, free_offer_expiration_time=None, reserved: bool = False, is_xenon: bool = False, hyper_v: bool = False, target_worker_count: int = None, target_worker_size_id: int = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
ARM resource for a app service plan.
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.
- 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.
- 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.
- free_offer_expiration_time (datetime) – The time when the server farm free offer expires.
- reserved (bool) – If Linux app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .
- is_xenon (bool) – Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .
- hyper_v (bool) – If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. Default value: False .
- target_worker_count (int) – Scaling worker count.
- target_worker_size_id (int) – Scaling worker size ID.
-
class
azure.mgmt.web.models.
HybridConnectionLimits
(*, kind: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: kind (str) – Kind of resource.
-
class
azure.mgmt.web.models.
ResourceHealthMetadata
(*, kind: str = None, category: str = None, signal_availability: bool = None, **kwargs)[source]¶ Bases:
azure.mgmt.web.models.proxy_only_resource_py3.ProxyOnlyResource
Used for getting ResourceHealthCheck settings.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - kind (str) – Kind of resource.
- category (str) – The category that the resource matches in the RHC Policy File
- signal_availability (bool) – Is there a health signal for the resource
-
class
azure.mgmt.web.models.
AppServiceCertificateOrderPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
AppServiceCertificateOrder
object
-
class
azure.mgmt.web.models.
AppServiceCertificateResourcePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
AppServiceCertificateResource
object
-
class
azure.mgmt.web.models.
CsmOperationDescriptionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
CsmOperationDescription
object
-
class
azure.mgmt.web.models.
DomainPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Domain
object
-
class
azure.mgmt.web.models.
NameIdentifierPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
NameIdentifier
object
-
class
azure.mgmt.web.models.
DomainOwnershipIdentifierPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DomainOwnershipIdentifier
object
-
class
azure.mgmt.web.models.
TopLevelDomainPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
TopLevelDomain
object
-
class
azure.mgmt.web.models.
TldLegalAgreementPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
TldLegalAgreement
object
-
class
azure.mgmt.web.models.
CertificatePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Certificate
object
-
class
azure.mgmt.web.models.
DeletedSitePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DeletedSite
object
-
class
azure.mgmt.web.models.
DetectorResponsePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DetectorResponse
object
-
class
azure.mgmt.web.models.
DiagnosticCategoryPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DiagnosticCategory
object
-
class
azure.mgmt.web.models.
AnalysisDefinitionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
AnalysisDefinition
object
-
class
azure.mgmt.web.models.
DetectorDefinitionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
DetectorDefinition
object
-
class
azure.mgmt.web.models.
ApplicationStackPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ApplicationStack
object
-
class
azure.mgmt.web.models.
RecommendationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Recommendation
object
-
class
azure.mgmt.web.models.
SourceControlPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SourceControl
object
-
class
azure.mgmt.web.models.
BillingMeterPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
BillingMeter
object
-
class
azure.mgmt.web.models.
GeoRegionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
GeoRegion
object
-
class
azure.mgmt.web.models.
IdentifierPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Identifier
object
-
class
azure.mgmt.web.models.
PremierAddOnOfferPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
PremierAddOnOffer
object
-
class
azure.mgmt.web.models.
SitePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Site
object
-
class
azure.mgmt.web.models.
BackupItemPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
BackupItem
object
-
class
azure.mgmt.web.models.
SiteConfigResourcePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SiteConfigResource
object
-
class
azure.mgmt.web.models.
SiteConfigurationSnapshotInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SiteConfigurationSnapshotInfo
object
-
class
azure.mgmt.web.models.
ContinuousWebJobPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ContinuousWebJob
object
-
class
azure.mgmt.web.models.
DeploymentPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Deployment
object
-
class
azure.mgmt.web.models.
FunctionEnvelopePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
FunctionEnvelope
object
-
class
azure.mgmt.web.models.
HostNameBindingPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
HostNameBinding
object
-
class
azure.mgmt.web.models.
SiteInstancePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SiteInstance
object
-
class
azure.mgmt.web.models.
ProcessInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ProcessInfo
object
-
class
azure.mgmt.web.models.
ProcessModuleInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ProcessModuleInfo
object
-
class
azure.mgmt.web.models.
ProcessThreadInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ProcessThreadInfo
object
-
class
azure.mgmt.web.models.
ResourceMetricDefinitionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ResourceMetricDefinition
object
-
class
azure.mgmt.web.models.
ResourceMetricPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ResourceMetric
object
-
class
azure.mgmt.web.models.
PerfMonResponsePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
PerfMonResponse
object
-
class
azure.mgmt.web.models.
PublicCertificatePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
PublicCertificate
object
-
class
azure.mgmt.web.models.
SiteExtensionInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SiteExtensionInfo
object
-
class
azure.mgmt.web.models.
SlotDifferencePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SlotDifference
object
-
class
azure.mgmt.web.models.
SnapshotPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Snapshot
object
-
class
azure.mgmt.web.models.
TriggeredWebJobPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
TriggeredWebJob
object
-
class
azure.mgmt.web.models.
TriggeredJobHistoryPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
TriggeredJobHistory
object
-
class
azure.mgmt.web.models.
CsmUsageQuotaPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
CsmUsageQuota
object
-
class
azure.mgmt.web.models.
WebJobPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
WebJob
object
-
class
azure.mgmt.web.models.
AppServiceEnvironmentResourcePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
AppServiceEnvironmentResource
object
-
class
azure.mgmt.web.models.
StampCapacityPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
StampCapacity
object
-
class
azure.mgmt.web.models.
WorkerPoolResourcePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
WorkerPoolResource
object
-
class
azure.mgmt.web.models.
SkuInfoPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
SkuInfo
object
-
class
azure.mgmt.web.models.
UsagePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Usage
object
-
class
azure.mgmt.web.models.
AppServicePlanPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
AppServicePlan
object
-
class
azure.mgmt.web.models.
StrPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of str object
-
class
azure.mgmt.web.models.
HybridConnectionPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
HybridConnection
object
-
class
azure.mgmt.web.models.
ResourceHealthMetadataPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ResourceHealthMetadata
object
-
class
azure.mgmt.web.models.
KeyVaultSecretStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
certificate_order_failed
= 'CertificateOrderFailed'¶
-
external_private_key
= 'ExternalPrivateKey'¶
-
initialized
= 'Initialized'¶
-
key_vault_does_not_exist
= 'KeyVaultDoesNotExist'¶
-
key_vault_secret_does_not_exist
= 'KeyVaultSecretDoesNotExist'¶
-
operation_not_permitted_on_key_vault
= 'OperationNotPermittedOnKeyVault'¶
-
succeeded
= 'Succeeded'¶
-
unknown
= 'Unknown'¶
-
unknown_error
= 'UnknownError'¶
-
waiting_on_certificate_order
= 'WaitingOnCertificateOrder'¶
-
-
class
azure.mgmt.web.models.
CertificateProductType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
standard_domain_validated_ssl
= 'StandardDomainValidatedSsl'¶
-
standard_domain_validated_wild_card_ssl
= 'StandardDomainValidatedWildCardSsl'¶
-
-
class
azure.mgmt.web.models.
ProvisioningState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
canceled
= 'Canceled'¶
-
deleting
= 'Deleting'¶
-
failed
= 'Failed'¶
-
in_progress
= 'InProgress'¶
-
succeeded
= 'Succeeded'¶
-
-
class
azure.mgmt.web.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.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.models.
RouteType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
default
= 'DEFAULT'¶
-
inherited
= 'INHERITED'¶
-
static
= 'STATIC'¶
-
-
class
azure.mgmt.web.models.
ManagedServiceIdentityType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
system_assigned
= 'SystemAssigned'¶
-
user_assigned
= 'UserAssigned'¶
-
-
class
azure.mgmt.web.models.
IpFilterTag
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
default
= 'Default'¶
-
xff_proxy
= 'XffProxy'¶
-
-
class
azure.mgmt.web.models.
AutoHealActionType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
custom_action
= 'CustomAction'¶
-
log_event
= 'LogEvent'¶
-
recycle
= 'Recycle'¶
-
-
class
azure.mgmt.web.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.models.
AzureStorageType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
azure_blob
= 'AzureBlob'¶
-
azure_files
= 'AzureFiles'¶
-
-
class
azure.mgmt.web.models.
AzureStorageState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
invalid_credentials
= 'InvalidCredentials'¶
-
ok
= 'Ok'¶
-
-
class
azure.mgmt.web.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.models.
ManagedPipelineMode
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
classic
= 'Classic'¶
-
integrated
= 'Integrated'¶
-
-
class
azure.mgmt.web.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.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.models.
FtpsState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
all_allowed
= 'AllAllowed'¶
-
disabled
= 'Disabled'¶
-
ftps_only
= 'FtpsOnly'¶
-
-
class
azure.mgmt.web.models.
SslState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
disabled
= 'Disabled'¶
-
ip_based_enabled
= 'IpBasedEnabled'¶
-
sni_enabled
= 'SniEnabled'¶
-
-
class
azure.mgmt.web.models.
HostType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
repository
= 'Repository'¶
-
standard
= 'Standard'¶
-
-
class
azure.mgmt.web.models.
UsageState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
exceeded
= 'Exceeded'¶
-
normal
= 'Normal'¶
-
-
class
azure.mgmt.web.models.
SiteAvailabilityState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
disaster_recovery_mode
= 'DisasterRecoveryMode'¶
-
limited
= 'Limited'¶
-
normal
= 'Normal'¶
-
-
class
azure.mgmt.web.models.
StatusOptions
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
creating
= 'Creating'¶
-
pending
= 'Pending'¶
-
ready
= 'Ready'¶
-
-
class
azure.mgmt.web.models.
DomainStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
active
= 'Active'¶
-
awaiting
= 'Awaiting'¶
-
cancelled
= 'Cancelled'¶
-
confiscated
= 'Confiscated'¶
-
disabled
= 'Disabled'¶
-
excluded
= 'Excluded'¶
-
expired
= 'Expired'¶
-
failed
= 'Failed'¶
-
held
= 'Held'¶
-
json_converter_failed
= 'JsonConverterFailed'¶
-
locked
= 'Locked'¶
-
parked
= 'Parked'¶
-
pending
= 'Pending'¶
-
reserved
= 'Reserved'¶
-
reverted
= 'Reverted'¶
-
suspended
= 'Suspended'¶
-
transferred
= 'Transferred'¶
-
unknown
= 'Unknown'¶
-
unlocked
= 'Unlocked'¶
-
unparked
= 'Unparked'¶
-
updated
= 'Updated'¶
-
-
class
azure.mgmt.web.models.
AzureResourceType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
traffic_manager
= 'TrafficManager'¶
-
website
= 'Website'¶
-
-
class
azure.mgmt.web.models.
CustomHostNameDnsRecordType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
a
= 'A'¶
-
cname
= 'CName'¶
-
-
class
azure.mgmt.web.models.
HostNameType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
managed
= 'Managed'¶
-
verified
= 'Verified'¶
-
-
class
azure.mgmt.web.models.
DnsType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
azure_dns
= 'AzureDns'¶
-
default_domain_registrar_dns
= 'DefaultDomainRegistrarDns'¶
-
-
class
azure.mgmt.web.models.
DomainType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
regular
= 'Regular'¶
-
soft_deleted
= 'SoftDeleted'¶
-
-
class
azure.mgmt.web.models.
HostingEnvironmentStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
deleting
= 'Deleting'¶
-
preparing
= 'Preparing'¶
-
ready
= 'Ready'¶
-
scaling
= 'Scaling'¶
-
-
class
azure.mgmt.web.models.
InternalLoadBalancingMode
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
none
= 'None'¶
-
publishing
= 'Publishing'¶
-
web
= 'Web'¶
-
-
class
azure.mgmt.web.models.
ComputeModeOptions
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
dedicated
= 'Dedicated'¶
-
dynamic
= 'Dynamic'¶
-
-
class
azure.mgmt.web.models.
WorkerSizeOptions
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
d1
= 'D1'¶
-
d2
= 'D2'¶
-
d3
= 'D3'¶
-
default
= 'Default'¶
-
large
= 'Large'¶
-
medium
= 'Medium'¶
-
small
= 'Small'¶
-
-
class
azure.mgmt.web.models.
AccessControlEntryAction
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
deny
= 'Deny'¶
-
permit
= 'Permit'¶
-
-
class
azure.mgmt.web.models.
OperationStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
created
= 'Created'¶
-
failed
= 'Failed'¶
-
in_progress
= 'InProgress'¶
-
succeeded
= 'Succeeded'¶
-
timed_out
= 'TimedOut'¶
-
-
class
azure.mgmt.web.models.
IssueType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
app_crash
= 'AppCrash'¶
-
app_deployment
= 'AppDeployment'¶
-
ase_deployment
= 'AseDeployment'¶
-
other
= 'Other'¶
-
platform_issue
= 'PlatformIssue'¶
-
runtime_issue_detected
= 'RuntimeIssueDetected'¶
-
service_incident
= 'ServiceIncident'¶
-
user_issue
= 'UserIssue'¶
-
-
class
azure.mgmt.web.models.
SolutionType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
best_practices
= 'BestPractices'¶
-
deep_investigation
= 'DeepInvestigation'¶
-
quick_solution
= 'QuickSolution'¶
-
-
class
azure.mgmt.web.models.
RenderingType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
no_graph
= 'NoGraph'¶
-
table
= 'Table'¶
-
time_series
= 'TimeSeries'¶
-
time_series_per_instance
= 'TimeSeriesPerInstance'¶
-
-
class
azure.mgmt.web.models.
ResourceScopeType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
server_farm
= 'ServerFarm'¶
-
subscription
= 'Subscription'¶
-
web_site
= 'WebSite'¶
-
-
class
azure.mgmt.web.models.
NotificationLevel
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
critical
= 'Critical'¶
-
information
= 'Information'¶
-
non_urgent_suggestion
= 'NonUrgentSuggestion'¶
-
warning
= 'Warning'¶
-
-
class
azure.mgmt.web.models.
Channels
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
all
= 'All'¶
-
api
= 'Api'¶
-
email
= 'Email'¶
-
notification
= 'Notification'¶
-
webhook
= 'Webhook'¶
-
-
class
azure.mgmt.web.models.
AppServicePlanRestrictions
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
basic
= 'Basic'¶
-
free
= 'Free'¶
-
none
= 'None'¶
-
standard
= 'Standard'¶
-
-
class
azure.mgmt.web.models.
InAvailabilityReasonType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
already_exists
= 'AlreadyExists'¶
-
invalid
= 'Invalid'¶
-
-
class
azure.mgmt.web.models.
CheckNameResourceTypes
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
hosting_environment
= 'HostingEnvironment'¶
-
microsoft_webhosting_environments
= 'Microsoft.Web/hostingEnvironments'¶
-
microsoft_webpublishing_users
= 'Microsoft.Web/publishingUsers'¶
-
microsoft_websites
= 'Microsoft.Web/sites'¶
-
microsoft_websitesslots
= 'Microsoft.Web/sites/slots'¶
-
publishing_user
= 'PublishingUser'¶
-
site
= 'Site'¶
-
slot
= 'Slot'¶
-
-
class
azure.mgmt.web.models.
ValidateResourceTypes
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
server_farm
= 'ServerFarm'¶
-
site
= 'Site'¶
-
-
class
azure.mgmt.web.models.
LogLevel
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
error
= 'Error'¶
-
information
= 'Information'¶
-
off
= 'Off'¶
-
verbose
= 'Verbose'¶
-
warning
= 'Warning'¶
-
-
class
azure.mgmt.web.models.
BackupItemStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
created
= 'Created'¶
-
delete_failed
= 'DeleteFailed'¶
-
delete_in_progress
= 'DeleteInProgress'¶
-
deleted
= 'Deleted'¶
-
failed
= 'Failed'¶
-
in_progress
= 'InProgress'¶
-
partially_succeeded
= 'PartiallySucceeded'¶
-
skipped
= 'Skipped'¶
-
succeeded
= 'Succeeded'¶
-
timed_out
= 'TimedOut'¶
-
-
class
azure.mgmt.web.models.
DatabaseType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
local_my_sql
= 'LocalMySql'¶
-
my_sql
= 'MySql'¶
-
postgre_sql
= 'PostgreSql'¶
-
sql_azure
= 'SqlAzure'¶
-
-
class
azure.mgmt.web.models.
FrequencyUnit
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
day
= 'Day'¶
-
hour
= 'Hour'¶
-
-
class
azure.mgmt.web.models.
ContinuousWebJobStatus
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
initializing
= 'Initializing'¶
-
pending_restart
= 'PendingRestart'¶
-
running
= 'Running'¶
-
starting
= 'Starting'¶
-
stopped
= 'Stopped'¶
-
-
class
azure.mgmt.web.models.
WebJobType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
continuous
= 'Continuous'¶
-
triggered
= 'Triggered'¶
-
-
class
azure.mgmt.web.models.
PublishingProfileFormat
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
file_zilla3
= 'FileZilla3'¶
-
ftp
= 'Ftp'¶
-
web_deploy
= 'WebDeploy'¶
-
-
class
azure.mgmt.web.models.
DnsVerificationTestResult
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
failed
= 'Failed'¶
-
passed
= 'Passed'¶
-
skipped
= 'Skipped'¶
-
-
class
azure.mgmt.web.models.
MSDeployLogEntryType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
error
= 'Error'¶
-
message
= 'Message'¶
-
warning
= 'Warning'¶
-
-
class
azure.mgmt.web.models.
MSDeployProvisioningState
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
accepted
= 'accepted'¶
-
canceled
= 'canceled'¶
-
failed
= 'failed'¶
-
running
= 'running'¶
-
succeeded
= 'succeeded'¶
-
-
class
azure.mgmt.web.models.
MySqlMigrationType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
local_to_remote
= 'LocalToRemote'¶
-
remote_to_local
= 'RemoteToLocal'¶
-
-
class
azure.mgmt.web.models.
PublicCertificateLocation
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
current_user_my
= 'CurrentUserMy'¶
-
local_machine_my
= 'LocalMachineMy'¶
-
unknown
= 'Unknown'¶
-
-
class
azure.mgmt.web.models.
BackupRestoreOperationType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
clone
= 'Clone'¶
-
cloud_fs
= 'CloudFS'¶
-
default
= 'Default'¶
-
relocation
= 'Relocation'¶
-
snapshot
= 'Snapshot'¶
-
-
class
azure.mgmt.web.models.
UnauthenticatedClientAction
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
allow_anonymous
= 'AllowAnonymous'¶
-
redirect_to_login_page
= 'RedirectToLoginPage'¶
-
-
class
azure.mgmt.web.models.
BuiltInAuthenticationProvider
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
azure_active_directory
= 'AzureActiveDirectory'¶
-
facebook
= 'Facebook'¶
-
google
= 'Google'¶
-
microsoft_account
= 'MicrosoftAccount'¶
-
twitter
= 'Twitter'¶
-
-
class
azure.mgmt.web.models.
CloneAbilityResult
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
cloneable
= 'Cloneable'¶
-
not_cloneable
= 'NotCloneable'¶
-
partially_cloneable
= 'PartiallyCloneable'¶
-
-
class
azure.mgmt.web.models.
SiteExtensionType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
gallery
= 'Gallery'¶
-
web_root
= 'WebRoot'¶
-