Share via


IWebAppBase Interface

Definition

An immutable client-side representation of an Azure Web App or deployment slot.

public interface IWebAppBase : Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IGroupableResource<Microsoft.Azure.Management.AppService.Fluent.IAppServiceManager,Microsoft.Azure.Management.AppService.Fluent.Models.SiteInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.AppService.Fluent.Models.SiteInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.AppService.Fluent.IAppServiceManager>
type IWebAppBase = interface
    interface IBeta
    interface IHasName
    interface IGroupableResource<IAppServiceManager, SiteInner>
    interface IResource
    interface IIndexable
    interface IHasId
    interface IHasResourceGroup
    interface IHasManager<IAppServiceManager>
    interface IHasInner<SiteInner>
Public Interface IWebAppBase
Implements IBeta, IGroupableResource(Of IAppServiceManager, SiteInner), IHasInner(Of SiteInner), IHasManager(Of IAppServiceManager)
Derived
Implements

Properties

AlwaysOn

Gets if the web app is always on.

AppServicePlanId

Gets The resource ID of the app service plan.

AutoSwapSlotName

Gets the auto swap slot name.

AvailabilityState

Gets management information availability state for the web app.

ClientAffinityEnabled

Gets if the client affinity is enabled when load balancing http request for multiple instances of the web app.

ClientCertEnabled

Gets if the client certificate is enabled for the web app.

CloningInfo

Gets information about whether the web app is cloned from another.

ContainerSize

Gets size of a function container.

DefaultDocuments

Gets the default documents.

DefaultHostName

Gets default hostname of the web app.

DiagnosticLogsConfig

Gets the diagnostic logs configuration.

DocumentRoot

Gets the root directory for the web app.

Enabled

Gets true if the site is enabled; otherwise, false.

EnabledHostNames

Gets host names for the web app that are enabled.

FtpsState

Gets the state of FTP / FTPS service.

HostNames

Gets hostnames associated with web app.

HostNamesDisabled

Gets if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process.

HostNameSslStates

Gets list of SSL states used to manage the SSL bindings for site's hostnames.

Http20Enabled

Gets whether to allow clients to connect over http2.0.

HttpsOnly

True if the web app is configured to accept only HTTPS requests. HTTP requests will be redirected.

Id

Gets the resource id string

(Inherited from IHasId)
Inner (Inherited from IHasInner<T>)
IsDefaultContainer

Gets site is a default container.

JavaContainer

Gets Java container.

JavaContainerVersion

Gets Java container version.

JavaVersion

Gets Java version.

Key (Inherited from IIndexable)
LastModifiedTime

Gets Last time web app was modified in UTC.

LinuxFxVersion

Gets the Linux app framework and version if this is a Linux web app.

LocalMySqlEnabled

Gets whether local MySQL is enabled.

ManagedPipelineMode

Gets managed pipeline mode.

Manager

Gets the manager client type of this resource type.

(Inherited from IHasManager<ManagerT>)
MinTlsVersion

Gets the minimum version of TLS required for SSL requests for the web app

Name

Gets the name of the resource

(Inherited from IHasName)
NetFrameworkVersion

Gets the .NET Framework version.

NodeVersion

Gets the version of Node.JS.

OperatingSystem

Gets the operating system the web app is running on.

OutboundIPAddresses

Gets list of IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.

PhpVersion

Gets the version of PHP.

PlatformArchitecture

Gets the architecture of the platform, either 32 bit (x86) or 64 bit (x64).

PythonVersion

Gets the version of Python.

Region (Inherited from IResource)
RegionName (Inherited from IResource)
RemoteDebuggingEnabled

Gets if the remote eebugging is enabled.

RemoteDebuggingVersion

Gets the remote debugging version.

RepositorySiteName

Gets name of repository site.

ResourceGroupName (Inherited from IHasResourceGroup)
ScmSiteAlsoStopped

Gets whether to stop SCM (KUDU) site when the web app is stopped. Default is false.

ScmType

Gets the SCM configuration for the web app.

State

Gets state of the web app.

SystemAssignedManagedServiceIdentityPrincipalId

Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the web app.

SystemAssignedManagedServiceIdentityTenantId

Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the web app.

Tags (Inherited from IResource)
TargetSwapSlot

Gets which slot this app will swap into.

TrafficManagerHostNames

Gets list of Azure Traffic manager host names associated with web app.

Type (Inherited from IResource)
UsageState

Gets state indicating whether web app has exceeded its quota usage.

UserAssignedManagedServiceIdentityIds

Gets The ids of the user assigned identities.

VirtualApplications

Gets the virtual applications and their virtual directories in this web app.

WebSocketsEnabled

Gets if web socket is enabled.

Methods

ApplySlotConfigurations(String)

Apply the slot (or sticky) configurations from the specified slot to the current one. This is useful for "Swap with Preview".

ApplySlotConfigurationsAsync(String, CancellationToken)

Apply the slot (or sticky) configurations from the specified slot to the current one. This is useful for "Swap with Preview".

Deploy()

First step specifying the parameters to make a web deployment (MS Deploy) to the web app.

GetAppSettings()
GetAppSettingsAsync(CancellationToken)
GetAuthenticationConfig()
GetAuthenticationConfigAsync(CancellationToken)
GetConnectionStrings()
GetConnectionStringsAsync(CancellationToken)
GetContainerLogs()
GetContainerLogsAsync(CancellationToken)
GetContainerLogsZip()
GetContainerLogsZipAsync(CancellationToken)
GetHostNameBindings()
GetHostNameBindingsAsync(CancellationToken)
GetPublishingProfile()
GetPublishingProfileAsync(CancellationToken)
GetSourceControl()
GetSourceControlAsync(CancellationToken)
ResetSlotConfigurations()

Reset the slot to its original configurations.

ResetSlotConfigurationsAsync(CancellationToken)

Reset the slot to its original configurations.

Restart()

Restarts the web app or deployment slot.

RestartAsync(CancellationToken)

Restarts the web app or deployment slot.

Start()

Starts the web app or deployment slot.

StartAsync(CancellationToken)

Starts the web app or deployment slot.

Stop()

Stops the web app or deployment slot.

StopAsync(CancellationToken)

Stops the web app or deployment slot.

StreamAllLogs()

Gets a open stream to all logs.

StreamAllLogsAsync(CancellationToken)

Gets a open stream to all logs.

StreamApplicationLogs()

Gets a open stream to the application logs.

StreamApplicationLogsAsync(CancellationToken)

Gets a open stream to the application logs.

StreamDeploymentLogs()

Gets a open stream to the deployment logs.

StreamDeploymentLogsAsync(CancellationToken)

Gets a open stream to the deployment logs.

StreamHttpLogs()

Gets a open stream to the HTTP logs.

StreamHttpLogsAsync(CancellationToken)

Gets a open stream to the HTTP logs.

StreamTraceLogs()

Gets a open stream to the trace logs.

StreamTraceLogsAsync(CancellationToken)

Gets a open stream to the trace logs.

Swap(String)

Swaps the app running in the current web app / slot with the app running in the specified slot.

SwapAsync(String, CancellationToken)

Swaps the app running in the current web app / slot with the app running in the specified slot.

VerifyDomainOwnership(String, String)

Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app.

VerifyDomainOwnershipAsync(String, String, CancellationToken)

Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app.

Applies to