models Package

Classes

AbnormalTimePeriod

Class representing Abnormal Time Period identified in diagnosis.

Address

Address information for domain registration.

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

AddressResponse

Describes main public IP address and any extra virtual IPs.

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

AllowedAudiencesValidation

AllowedAudiencesValidation.

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

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.

ApiManagementConfig

Azure API management (APIM) configuration linked to the app.

AppRegistration

AppRegistration.

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

AppServiceCertificate

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.

AppServiceCertificateCollection

Collection of certificate order 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 Azure.

AppServiceCertificateOrder

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.

AppServiceCertificateOrderCollection

Collection of certificate orders.

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.

AppServiceCertificateOrderPatchResource

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.

AppServiceCertificatePatchResource

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.

AppServiceCertificateResource

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.

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

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

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

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

AppServicePlanCollection

Collection of App Service plans.

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.

AppServicePlanPatchResource

ARM resource for a app service plan.

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

ApplicationLogsConfig

Application logs configuration.

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

ApplicationStackResource

ARM resource for a ApplicationStack.

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

AppserviceGithubToken

Github access token for Appservice CLI github integration.

AppserviceGithubTokenRequest

Appservice Github token request content.

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

ArmIdWrapper

A wrapper for an ARM resource id.

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

AuthPlatform

AuthPlatform.

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.

param exe: Executable to be run.

type exe: str

param parameters: Parameters for the executable.

type parameters: str

AutoHealRules

Rules that can be defined for auto-heal.

AutoHealTriggers

Triggers for auto-heal.

AzureActiveDirectory

AzureActiveDirectory.

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

AzureActiveDirectoryLogin

AzureActiveDirectoryLogin.

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

AzureActiveDirectoryRegistration

AzureActiveDirectoryRegistration.

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

AzureActiveDirectoryValidation

AzureActiveDirectoryValidation.

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

AzureBlobStorageApplicationLogsConfig

Application logs azure blob storage configuration.

AzureBlobStorageHttpLogsConfig

Http logs to azure blob storage configuration.

AzureStorageInfoValue

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.

AzureStoragePropertyDictionaryResource

AzureStorageInfo dictionary resource.

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

AzureTableStorageApplicationLogsConfig

Application logs to Azure table storage configuration.

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

BackupItem

Backup description.

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

BackupItemCollection

Collection of backup items.

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.

BackupRequest

Description of a backup which will be performed.

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

BackupSchedule

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.

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

BlobStorageTokenStore

BlobStorageTokenStore.

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

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

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

CertificateDetails

SSL certificate details.

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

CertificateEmail

SSL certificate email.

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

CertificateOrderAction

Certificate order action.

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

CertificatePatchResource

ARM resource for a certificate.

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

ClientRegistration

ClientRegistration.

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

/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.Network/trafficManagerProfiles/{profileName}. :type traffic_manager_profile_id: str :param traffic_manager_profile_name: Name of Traffic Manager profile to create. This is only

needed if Traffic Manager profile does not already exist.

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties.

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

ConnStringInfo

Database connection string information.

ConnStringValueTypePair

Database connection string value to type pair.

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

ConnectionStringDictionary

String dictionary resource.

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

Contact

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.

param address_mailing: Mailing address.

type address_mailing: ~azure.mgmt.web.v2020_09_01.models.Address

param email: Required. Email address.

type email: str

param fax: Fax number.

type fax: str

param job_title: Job title.

type job_title: str

param name_first: Required. First name.

type name_first: str

param name_last: Required. Last name.

type name_last: str

param name_middle: Middle name.

type name_middle: str

param organization: Organization contact belongs to.

type organization: str

param phone: Required. Phone number.

type phone: str

ContainerCpuStatistics

ContainerCpuStatistics.

ContainerCpuUsage

ContainerCpuUsage.

ContainerInfo

ContainerInfo.

ContainerMemoryStatistics

ContainerMemoryStatistics.

ContainerNetworkInterfaceStatistics

ContainerNetworkInterfaceStatistics.

ContainerThrottlingData

ContainerThrottlingData.

ContinuousWebJob

Continuous Web Job Information.

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

ContinuousWebJobCollection

Collection of Kudu continuous web job information elements.

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.

CookieExpiration

CookieExpiration.

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

CorsSettings

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

CsmCopySlotEntity

Copy deployment slot parameters.

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

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

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.

CsmPublishingCredentialsPoliciesCollection

Publishing Credentials Policies collection.

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

CsmPublishingCredentialsPoliciesEntity

Publishing Credentials Policies parameters.

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

CsmPublishingProfileOptions

Publishing options for requested profile.

CsmSlotEntity

Deployment slot parameters.

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

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

CustomHostnameAnalysisResult

Custom domain analysis.

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

CustomOpenIdConnectProvider

CustomOpenIdConnectProvider.

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

DataSource

Class representing data source used by the detectors.

DataTableResponseColumn

Column definition.

DataTableResponseObject

Data Table which defines columns and raw row values.

DatabaseBackupSetting

Database backup settings.

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

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.

DeletedAppRestoreRequest

Details about restoring a deleted app.

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

Deployment

User credentials used for publishing activity.

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

DeploymentCollection

Collection of app deployments.

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.

DeploymentLocations

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

param locations: Available regions.

type locations: list[~azure.mgmt.web.v2020_09_01.models.GeoRegion]

param hosting_environments: Available App Service Environments with full descriptions of the environments.

type hosting_environments: list[~azure.mgmt.web.v2020_09_01.models.AppServiceEnvironment]

param hosting_environment_deployment_infos: Available App Service Environments with basic information.

type hosting_environment_deployment_infos: list[~azure.mgmt.web.v2020_09_01.models.HostingEnvironmentDeploymentInfo]

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

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

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

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

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.

param name: type name: str

param display_name: type display_name: str

param internal_name: type internal_name: str

param to_be_exported_for_shoebox: type to_be_exported_for_shoebox: bool

Domain

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.

DomainAvailabilityCheckResult

Domain availability check result.

DomainCollection

Collection of domains.

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.

DomainControlCenterSsoRequest

Single sign-on request information for domain management.

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

DomainOwnershipIdentifier

Domain ownership Identifier.

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

DomainOwnershipIdentifierCollection

Collection of domain ownership 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 Azure.

DomainPatchResource

ARM resource for a domain.

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

DomainPurchaseConsent

Domain purchase consent object, representing acceptance of applicable legal agreements.

DomainRecommendationSearchParameters

Domain recommendation search parameters.

EnabledConfig

Enabled configuration.

EndpointDependency

A domain name that a service is reached at, including details of the current connection status.

EndpointDetail

Current TCP connectivity information from the App Service Environment to a single endpoint.

ErrorEntity

Body of the error response returned from the API.

Experiments

Routing rules in production experiments.

Facebook

Facebook.

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

FileSystemApplicationLogsConfig

Application logs to file system configuration.

FileSystemHttpLogsConfig

Http logs to file system configuration.

FileSystemTokenStore

FileSystemTokenStore.

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

ForwardProxy

ForwardProxy.

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

FunctionEnvelope

Function information.

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

FunctionEnvelopeCollection

Collection of Kudu function information elements.

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.

FunctionSecrets

Function secrets.

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

GitHub

GitHub.

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

GlobalCsmSkuDescription

A Global SKU Description.

GlobalValidation

GlobalValidation.

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

Google

Google.

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

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.

param extension: Requests with this extension will be handled using the specified FastCGI application.

type extension: str

param script_processor: The absolute path to the FastCGI application.

type script_processor: str

param arguments: Command-line arguments to be passed to the script processor.

type arguments: str

HostKeys

Functions host level keys.

HostName

Details of a hostname derived from a domain.

HostNameBinding

A hostname binding object.

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

HostNameBindingCollection

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

HostNameSslState

SSL-enabled hostname.

HostingEnvironmentDeploymentInfo

Information needed to create resources on an App Service Environment.

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.

HttpLogsConfig

Http logs configuration.

HttpSettings

HttpSettings.

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

HttpSettingsRoutes

HttpSettingsRoutes.

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

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.

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

IdentityProviders

IdentityProviders.

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

InboundEnvironmentEndpoint

The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.

InboundEnvironmentEndpointCollection

Collection of Inbound Environment Endpoints.

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.

IpSecurityRestriction

IP security restriction on an app.

JwtClaimChecks

JwtClaimChecks.

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

KeyInfo

Function key info.

LocalizableString

Localizable string object containing the name and a localized value.

LogSpecification

Log Definition of a single resource metric.

Login

Login.

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

LoginRoutes

LoginRoutes.

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

LoginScopes

LoginScopes.

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

MSDeploy

MSDeploy ARM PUT information.

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

MSDeployLog

MSDeploy log.

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

MSDeployLogEntry

MSDeploy log entry.

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

MSDeployStatus

MSDeploy ARM response.

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

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.

MigrateMySqlRequest

MySQL migration request.

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

MigrateMySqlStatus

MySQL migration status.

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

NameIdentifier

Identifies an object.

NameIdentifierCollection

Collection of domain name 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 Azure.

NameValuePair

Name value pair.

NetworkAccessControlEntry

Network access control entry.

NetworkFeatures

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.

NetworkTrace

Network trace.

Nonce

Nonce.

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

OpenIdConnectClientCredential

OpenIdConnectClientCredential.

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

OpenIdConnectConfig

OpenIdConnectConfig.

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

OpenIdConnectLogin

OpenIdConnectLogin.

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

OpenIdConnectRegistration

OpenIdConnectRegistration.

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

Operation

An operation on a resource.

OutboundEnvironmentEndpoint

Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.

OutboundEnvironmentEndpointCollection

Collection of Outbound Environment Endpoints.

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.

PerfMonCounterCollection

Collection of performance monitor counters.

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.

PerfMonResponse

Performance monitor API response.

PerfMonSample

Performance monitor sample in a set.

PerfMonSet

Metric information.

PremierAddOn

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.

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

PremierAddOnPatchResource

ARM resource for a PremierAddOn.

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

PrivateAccess

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.

PrivateAccessSubnet

Description of a Virtual Network subnet that is useable for private site access.

PrivateAccessVirtualNetwork

Description of a Virtual Network that is useable for private site access.

PrivateEndpointConnectionResource

Private Endpoint Connection ARM resource.

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

PrivateLinkConnectionApprovalRequestResource

Private Endpoint Connection Approval ARM resource.

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

PrivateLinkConnectionState

The state of a private link connection.

PrivateLinkResource

A private link resource.

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

PrivateLinkResourceProperties

Properties of a private link resource.

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

PrivateLinkResourcesWrapper

Wrapper for a collection of private link resources.

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

ProcessInfo

Process Information.

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

ProcessInfoCollection

Collection of Kudu process information elements.

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.

ProcessModuleInfo

Process Module Information.

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

ProcessModuleInfoCollection

Collection of Kudu thread information elements.

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.

ProcessThreadInfo

Process Thread Information.

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

ProcessThreadInfoCollection

Collection of Kudu thread information elements.

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.

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.

PublicCertificate

Public certificate object.

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

PublicCertificateCollection

Collection of public 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 Azure.

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.

param action_host_name: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

type action_host_name: str

param reroute_percentage: Percentage of the traffic which will be redirected to <code>ActionHostName</code>.

type reroute_percentage: float

param change_step: In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches

<code>MinReroutePercentage</code> or <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.

Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.

type change_step: float

param change_interval_in_minutes: Specifies interval in minutes to reevaluate ReroutePercentage.

type change_interval_in_minutes: int

param min_reroute_percentage: Specifies lower boundary above which ReroutePercentage will stay.

type min_reroute_percentage: float

param max_reroute_percentage: Specifies upper boundary below which ReroutePercentage will stay.

type max_reroute_percentage: float

param change_decision_callback_url: 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/.

type change_decision_callback_url: str

param name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

type name: str

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

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.

ReissueCertificateOrderRequest

Class representing certificate reissue request.

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

RelayServiceConnectionEntity

Hybrid Connection for an App Service app.

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

Rendering

Instructions for rendering the data.

RenewCertificateOrderRequest

Class representing certificate renew request.

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

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

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

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

ResourceMetricAvailability

Metrics availability and retention.

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

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

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

ResponseMetaData

ResponseMetaData.

RestoreRequest

Description of a restore request.

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

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

SiteAuthSettings

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.

SiteAuthSettingsV2

SiteAuthSettingsV2.

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

SiteCloneability

Represents whether or not an app is cloneable.

SiteCloneabilityCriterion

An app cloneability criterion.

SiteConfig

Configuration of an App Service app.

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

SiteConfigResource

Web app configuration ARM resource.

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

SiteConfigResourceCollection

Collection of site configurations.

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.

SiteConfigurationSnapshotInfo

A snapshot of a web app configuration.

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

SiteConfigurationSnapshotInfoCollection

Collection of metadata for the app configuration snapshots that can be restored.

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.

SiteExtensionInfo

Site Extension Information.

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

SiteExtensionInfoCollection

Collection of Kudu site extension information elements.

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.

SiteLimits

Metric limits set on an app.

SiteLogsConfig

Configuration of App Service site logs.

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

SiteMachineKey

MachineKey of an app.

SitePatchResource

ARM resource for a site.

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

SitePhpErrorLogFlag

Used for getting PHP error logging flag.

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

SiteSeal

Site seal.

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

SiteSealRequest

Site seal request.

SiteSourceControl

Source control configuration for an app.

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

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

SkuInfos

Collection of SKU information.

SlotConfigNamesResource

Slot Config names azure resource.

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

SlotDifference

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.

SlotDifferenceCollection

Collection of slot differences.

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.

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.

Snapshot

A snapshot of an app.

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

SnapshotCollection

Collection of snapshots which can be used to revert an app to a previous time.

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.

SnapshotRecoverySource

Specifies the web app that snapshot contents will be retrieved from.

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

SnapshotRestoreRequest

Details about app recovery operation.

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

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

StackMajorVersion

Application stack major version.

StackMinorVersion

Application stack minor version.

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

StaticSiteARMResource

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

StaticSiteBuildARMResource

Static Site Build ARM resource.

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

StaticSiteBuildCollection

Collection of static site builds.

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.

StaticSiteBuildProperties

Build properties for the static site.

StaticSiteCollection

Collection of static sites.

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.

StaticSiteCustomDomainOverviewARMResource

Static Site Custom Domain Overview ARM resource.

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

StaticSiteCustomDomainOverviewCollection

Collection of static site custom domains.

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.

StaticSiteFunctionOverviewARMResource

Static Site Function Overview ARM resource.

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

StaticSiteFunctionOverviewCollection

Collection of static site functions.

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.

StaticSitePatchResource

ARM resource for a static site when patching.

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

StaticSiteResetPropertiesARMResource

Static Site Reset Properties ARM resource.

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

StaticSiteUserARMResource

Static Site User ARM resource.

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

StaticSiteUserCollection

Collection of static site custom users.

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.

StaticSiteUserInvitationRequestResource

Static sites user roles invitation resource.

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

StaticSiteUserInvitationResponseResource

Static sites user roles invitation link resource.

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

StaticSitesWorkflowPreview

Preview for the Static Site Workflow to be generated.

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

StaticSitesWorkflowPreviewRequest

Request entity for previewing the Static Site workflow.

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

StatusCodesBasedTrigger

Trigger based on status code.

StorageMigrationOptions

Options for app content migration.

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

StorageMigrationResponse

Response for a migration of app content request.

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

StringDictionary

String dictionary resource.

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

SwiftVirtualNetwork

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.

SystemData

Metadata pertaining to creation and last modification of the resource.

TldLegalAgreement

Legal agreement for a top level domain.

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

TldLegalAgreementCollection

Collection of top-level domain legal agreements.

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.

TokenStore

TokenStore.

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

TopLevelDomain

A top level domain object.

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

TopLevelDomainAgreementOption

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

TopLevelDomainCollection

Collection of Top-level domains.

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.

TriggeredJobHistory

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.

TriggeredJobHistoryCollection

Collection of Kudu continuous web job information elements.

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.

TriggeredJobRun

Triggered Web Job Run Information.

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

TriggeredWebJob

Triggered Web Job Information.

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

TriggeredWebJobCollection

Collection of Kudu continuous web job information elements.

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.

Twitter

Twitter.

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

TwitterRegistration

TwitterRegistration.

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

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

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

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

WebAppInstanceStatusCollection

Collection of app instances.

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.

WebJob

Web Job Information.

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

WebJobCollection

Collection of Kudu web job information elements.

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.

WebSiteInstanceStatus

WebSiteInstanceStatus.

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

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

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.

AppServiceCertificateOrderPatchResourcePropertiesAppServiceCertificateNotRenewableReasonsItem

An enumeration.

AppServiceCertificateOrderPropertiesAppServiceCertificateNotRenewableReasonsItem

An enumeration.

AppServicePlanRestrictions

App Service plans this offer is restricted to.

AutoHealActionType

Predefined action to be taken.

AzureResourceType

Type of the Azure resource the hostname is assigned to.

AzureStorageState

State of the storage account.

AzureStorageType

Type of storage.

BackupItemStatus

Backup status.

BackupRestoreOperationType

Operation type.

BuildStatus

The status of the static site build.

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

CertificateOrderActionType

Action type.

CertificateOrderStatus

Current order status.

CertificateProductType

Certificate product type.

Channels

List of channels that this recommendation can apply.

CheckNameResourceTypes

Resource type used for verification.

ClientCertMode

This composes with ClientCertEnabled setting.

  • ClientCertEnabled: false means ClientCert is ignored.

  • ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.

  • ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or

accepted.

CloneAbilityResult

Name of app.

ComputeModeOptions

Shared/dedicated workers.

ConnectionStringType

Type of database.

ContinuousWebJobStatus

Job status.

CookieExpirationConvention

An enumeration.

CreatedByType

The type of identity that created the resource.

CustomHostNameDnsRecordType

Type of the DNS record.

DatabaseType

Database type (e.g. SqlAzure / MySql).

DnsType

Current DNS type

DnsVerificationTestResult

DNS verification test result.

DomainPatchResourcePropertiesDomainNotRenewableReasonsItem

An enumeration.

DomainPropertiesDomainNotRenewableReasonsItem

An enumeration.

DomainStatus

Domain registration status.

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.

Enum5

An enumeration.

Enum6

An enumeration.

ForwardProxyConvention

An enumeration.

FrequencyUnit

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)

FtpsState

State of FTP / FTPS service

HostNameType

Type of the hostname.

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.

IpFilterTag

Defines what this IP filter will be used for. This is to support IP filtering on proxies.

IssueType

Represents the type of the Detector

KeyVaultSecretStatus

Status of the Key Vault secret.

LoadBalancingMode

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

LogLevel

Log level.

MSDeployLogEntryType

Log entry type

MSDeployProvisioningState

Provisioning state

ManagedPipelineMode

Managed pipeline mode.

ManagedServiceIdentityType

Type of managed service identity.

MySqlMigrationType

The type of migration operation to be done

NotificationLevel

Level indicating how critical this recommendation can impact.

OperationStatus

The current status of the operation.

ProvisioningState

Status of certificate order.

PublicCertificateLocation

Public Certificate Location

PublishingProfileFormat

Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp

RedundancyMode

Site redundancy mode

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.

SiteExtensionType

Site extension type.

SiteLoadBalancing

Site load balancing.

SiteRuntimeState

An enumeration.

SkuName

An enumeration.

SolutionType

Type of Solution

SslState

SSL type.

StatusOptions

App Service plan status.

SupportedTlsVersions

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

TriggerTypes

The trigger type of the function

TriggeredWebJobStatus

Job status.

UnauthenticatedClientAction

The action to take when an unauthenticated client attempts to access the app.

UnauthenticatedClientActionV2

An enumeration.

UsageState

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

ValidateResourceTypes

Resource type used for verification.

WebJobType

Job type.

WorkerSizeOptions

Size of the machines.