models Package

Classes

AddressResponse

Describes main public IP address and any extra virtual IPs.

ApiDefinitionInfo

Information about the formal API definition for the app.

AppServiceEnvironmentCollection

Collection of App Service Environments.

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

AppServiceEnvironmentPatchResource

ARM resource for a app service environment.

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

AppServiceEnvironmentResource

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

AppServicePlan

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

AppServicePlanCollection

Collection of App Service plans.

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

AppServicePlanPatchResource

ARM resource for a app service plan.

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

AutoHealActions

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

AutoHealCustomAction

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

AutoHealRules

Rules that can be defined for auto-heal.

AutoHealTriggers

Triggers for auto-heal.

Capability

Describes the capabilities/features allowed for a specific SKU.

CloningInfo

Information needed for cloning operation.

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

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

/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. # pylint: disable=line-too-long :vartype traffic_manager_profile_id: str :ivar traffic_manager_profile_name: Name of Traffic Manager profile to create. This is only

needed if Traffic Manager profile does not already exist.

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

/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. # pylint: disable=line-too-long :paramtype traffic_manager_profile_id: str :keyword traffic_manager_profile_name: Name of Traffic Manager profile to create. This is only

needed if Traffic Manager profile does not already exist.

ConnStringInfo

Database connection string information.

CorsSettings

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

CsmUsageQuota

Usage of the quota resource.

CsmUsageQuotaCollection

Collection of CSM usage quotas.

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

ErrorEntity

Body of the error response returned from the API.

Experiments

Routing rules in production experiments.

HandlerMapping

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.

HostNameSslState

SSL-enabled hostname.

HostingEnvironmentDiagnostics

Diagnostics for an App Service Environment.

HostingEnvironmentProfile

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.

HybridConnection

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.

HybridConnectionCollection

Collection of hostname bindings.

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

HybridConnectionKey

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.

HybridConnectionLimits

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.

IpSecurityRestriction

IP security restriction on an app.

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

LocalizableString

Localizable string object containing the name and a localized value.

ManagedServiceIdentity

Managed service identity.

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

MetricAvailabilily

Metric availability and retention.

MetricDefinition

Metadata for a metric.

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

NameValuePair

Name value pair.

NetworkAccessControlEntry

Network access control entry.

Operation

An operation on a resource.

ProxyOnlyResource

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.

PushSettings

Push settings for the App.

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

RampUpRule

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

RequestsBasedTrigger

Trigger based on total requests.

Resource

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

ResourceCollection

Collection of resources.

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

ResourceMetric

Object representing a metric for any resource .

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

ResourceMetricAvailability

Metrics availability and retention.

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

ResourceMetricCollection

Collection of metric responses.

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

ResourceMetricDefinition

Metadata for the metrics.

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

ResourceMetricDefinitionCollection

Collection of metric definitions.

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

ResourceMetricName

Name of a metric for any resource .

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

ResourceMetricProperty

Resource metric property.

ResourceMetricValue

Value of resource metric.

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

Site

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

SiteConfig

Configuration of an App Service app.

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

SiteLimits

Metric limits set on an app.

SiteMachineKey

MachineKey of an app.

SkuCapacity

Description of the App Service plan scale options.

SkuDescription

Description of a SKU for a scalable resource.

SkuInfo

SKU discovery information.

SkuInfoCollection

Collection of SKU information.

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

SlotSwapStatus

The status of the last successful slot swap operation.

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

SlowRequestsBasedTrigger

Trigger based on request execution time.

SnapshotRecoveryRequest

Details about app recovery operation.

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

SnapshotRecoveryTarget

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

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

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

StampCapacity

Stamp capacity information.

StampCapacityCollection

Collection of stamp capacities.

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

StatusCodesBasedTrigger

Trigger based on status code.

Usage

Usage of the quota resource.

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

UsageCollection

Collection of usages.

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

VirtualApplication

Virtual application in an app.

VirtualDirectory

Directory for virtual application.

VirtualIPMapping

Virtual IP mapping.

VirtualNetworkProfile

Specification for using a Virtual Network.

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

VnetGateway

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.

VnetInfo

Virtual Network information contract.

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

VnetRoute

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.

WebAppCollection

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

WorkerPool

Worker pool of an App Service Environment.

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

WorkerPoolCollection

Collection of worker pools.

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

WorkerPoolResource

Worker pool of an App Service Environment ARM resource.

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

Enums

AccessControlEntryAction

Action object.

AutoHealActionType

Predefined action to be taken.

ComputeModeOptions

Shared/dedicated workers.

ConnectionStringType

Type of database.

HostType

Indicates whether the hostname is a standard or repository hostname.

HostingEnvironmentStatus

Current status of the App Service Environment.

InternalLoadBalancingMode

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

ManagedPipelineMode

Managed pipeline mode.

ManagedServiceIdentityType

Type of managed service identity.

OperationStatus

The current status of the operation.

ProvisioningState

Provisioning state of the App Service Environment.

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.

ScmType

SCM type.

SiteAvailabilityState

Management information availability state for the app.

SiteLoadBalancing

Site load balancing.

SslState

SSL type.

StatusOptions

App Service plan status.

SupportedTlsVersions

MinTlsVersion: configures the minimum version of TLS required for SSL requests.

UsageState

State indicating whether the app has exceeded its quota usage. Read-only.

WorkerSizeOptions

Size of the machines.