models Package

Classes

AbnormalTimePeriod

Class representing Abnormal Time Period identified in diagnosis.

AnalysisData

Class Representing Detector Evidence used for analysis.

AnalysisDefinition

Definition of Analysis.

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

ApiDefinitionInfo

Information about the formal API definition for the app.

AppServiceEnvironment

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

ApplicationStack

Application stack.

ApplicationStackCollection

Collection of Application Stacks.

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.

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.

BillingMeter

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.

BillingMeterCollection

Collection of Billing Meters.

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.

Capability

Describes the capabilities/features allowed for a specific SKU.

Certificate

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

CertificateCollection

Collection of certificates.

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.

CertificatePatchResource

ARM resource for a certificate.

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

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.

CsmMoveResourceEnvelope

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

CsmOperationCollection

Collection of Azure resource manager operation metadata.

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.

CsmOperationDescription

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

CsmOperationDescriptionProperties

Properties available for a Microsoft.Web resource provider operation.

CsmOperationDisplay

Meta data about operation used for display in portal.

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.

DataSource

Class representing data source used by the detectors.

DataTableResponseColumn

Column definition.

DataTableResponseObject

Data Table which defines columns and raw row values.

DefaultErrorResponse

App Service error response.

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

DefaultErrorResponseError

Error model.

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

DefaultErrorResponseErrorDetailsItem

Detailed errors.

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

DeletedSite

A deleted app.

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

DeletedWebAppCollection

Collection of deleted 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.

DeploymentLocations

List of available locations (regions or App Service Environments) for deployment of App Service resources.

DetectorAbnormalTimePeriod

Class representing Abnormal Time Period detected.

DetectorDefinition

Class representing detector definition.

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

DetectorInfo

Definition of Detector.

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

DetectorResponse

Class representing Response from Detector.

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

DetectorResponseCollection

Collection of detector 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.

DiagnosticAnalysis

Class representing a diagnostic analysis done on an application.

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

DiagnosticAnalysisCollection

Collection of Diagnostic Analyses.

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.

DiagnosticCategory

Class representing detector definition.

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

DiagnosticCategoryCollection

Collection of Diagnostic Categories.

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.

DiagnosticData

Set of data with rendering instructions.

DiagnosticDetectorCollection

Collection of Diagnostic Detectors.

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.

DiagnosticDetectorResponse

Class representing Response from Diagnostic Detectors.

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

DiagnosticMetricSample

Class representing Diagnostic Metric.

DiagnosticMetricSet

Class representing Diagnostic Metric information.

Dimension

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.

ErrorEntity

Body of the error response returned from the API.

Experiments

Routing rules in production experiments.

GeoRegion

Geographical region.

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

GeoRegionCollection

Collection of geographical regions.

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.

GlobalCsmSkuDescription

A Global SKU Description.

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.

HostingEnvironmentDeploymentInfo

Information needed to create resources on 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.

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.

Identifier

A domain specific resource identifier.

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

IdentifierCollection

Collection of identifiers.

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.

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.

MetricAvailability

Retention policy of a resource metric.

MetricSpecification

Definition of a single resource metric.

NameIdentifier

Identifies an object.

NameValuePair

Name value pair.

NetworkAccessControlEntry

Network access control entry.

Operation

An operation on a resource.

PremierAddOnOffer

Premier add-on offer.

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

PremierAddOnOfferCollection

Collection of premier add-on offers.

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.

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.

Recommendation

Represents a recommendation result generated by the recommendation engine.

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

RecommendationCollection

Collection of recommendations.

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.

RecommendationRule

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.

Rendering

Instructions for rendering the data.

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.

ResourceHealthMetadata

Used for getting ResourceHealthCheck settings.

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

ResourceHealthMetadataCollection

Collection of resource health metadata.

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.

ResourceNameAvailability

Information regarding availability of a resource name.

ResourceNameAvailabilityRequest

Resource name availability request content.

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

ResponseMetaData

ResponseMetaData.

ServiceSpecification

Resource metrics service provided by Microsoft.Insights resource provider.

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.

SkuInfos

Collection of SKU information.

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.

Solution

Class Representing Solution for problems detected.

SourceControl

The source control OAuth token.

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

SourceControlCollection

Collection of source controls.

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.

StackMajorVersion

Application stack major version.

StackMinorVersion

Application stack minor version.

StampCapacity

Stamp capacity information.

StatusCodesBasedTrigger

Trigger based on status code.

User

User credentials used for publishing activity.

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

ValidateRequest

Resource validation request content.

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

ValidateResponse

Describes the result of resource validation.

ValidateResponseError

Error details for when validation fails.

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.

VnetParameters

The required set of inputs to validate a VNET.

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.

VnetValidationFailureDetails

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.

VnetValidationTestFailure

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.

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.

Enums

AccessControlEntryAction

Action object.

AppServicePlanRestrictions

App Service plans this offer is restricted to.

AutoHealActionType

Predefined action to be taken.

Channels

List of channels that this recommendation can apply.

CheckNameResourceTypes

Resource type used for verification.

ComputeModeOptions

Shared/dedicated workers.

ConnectionStringType

Type of database.

Enum0

Enum0.

Enum1

Enum1.

HostType

Indicates whether the hostname is a standard or repository hostname.

HostingEnvironmentStatus

Current status of the App Service Environment.

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.

InternalLoadBalancingMode

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

IssueType

Represents the type of the Detector.

KeyVaultSecretStatus

Status of the Key Vault secret.

ManagedPipelineMode

Managed pipeline mode.

ManagedServiceIdentityType

Type of managed service identity.

NotificationLevel

Level indicating how critical this recommendation can impact.

OperationStatus

The current status of the operation.

ProvisioningState

Provisioning state of the App Service Environment.

RenderingType

Rendering Type.

ResourceScopeType

Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.

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.

SkuName

SkuName.

SolutionType

Type of Solution.

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.

ValidateResourceTypes

Resource type used for verification.

WorkerSizeOptions

Size of the machines.