WebAppBase Interface

Implements

public interface WebAppBase
extends HasName, GroupableResource<AppServiceManager,SiteInner>, WebSiteBase

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

Method Summary

Modifier and Type Method and Description
abstract boolean alwaysOn()
abstract void applySlotConfigurations(String slotName)

Apply the slot (or sticky) configurations from the specified slot to the current one.

abstract Mono<Void> applySlotConfigurationsAsync(String slotName)

Apply the slot (or sticky) configurations from the specified slot to the current one.

abstract String autoSwapSlotName()
abstract List<String> defaultDocuments()
abstract WithPackageUri deploy()

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

abstract WebAppDiagnosticLogs diagnosticLogsConfig()
abstract String documentRoot()
abstract FtpsState ftpsState()
abstract Map<String,AppSetting> getAppSettings()
abstract Mono<Map<String,AppSetting>> getAppSettingsAsync()
abstract WebAppAuthentication getAuthenticationConfig()
abstract Mono<WebAppAuthentication> getAuthenticationConfigAsync()
abstract Map<String,ConnectionString> getConnectionStrings()
abstract Mono<Map<String,ConnectionString>> getConnectionStringsAsync()
abstract byte[] getContainerLogs()
abstract Mono<byte[]> getContainerLogsAsync()
abstract byte[] getContainerLogsZip()
abstract Mono<byte[]> getContainerLogsZipAsync()
abstract Map<String,HostnameBinding> getHostnameBindings()
abstract Mono<Map<String,HostnameBinding>> getHostnameBindingsAsync()
abstract PublishingProfile getPublishingProfile()
abstract Mono<PublishingProfile> getPublishingProfileAsync()
abstract Map<String,String> getSiteAppSettings()

Gets the App Settings on site from Kudu client.

abstract Mono<Map<String,String>> getSiteAppSettingsAsync()

Gets the App Settings on site from Kudu client.

abstract WebAppSourceControl getSourceControl()
abstract Mono<WebAppSourceControl> getSourceControlAsync()
abstract boolean http20Enabled()
abstract List<IpSecurityRestriction> ipSecurityRules()
abstract String javaContainer()
abstract String javaContainerVersion()
abstract JavaVersion javaVersion()
abstract String linuxFxVersion()
abstract boolean localMySqlEnabled()
abstract ManagedPipelineMode managedPipelineMode()
abstract SupportedTlsVersions minTlsVersion()
abstract NetFrameworkVersion netFrameworkVersion()
abstract String nodeVersion()
abstract PhpVersion phpVersion()
abstract PlatformArchitecture platformArchitecture()
abstract PublicNetworkAccess publicNetworkAccess()

Whether the web app can be accessed from public network.

abstract PythonVersion pythonVersion()
abstract boolean remoteDebuggingEnabled()
abstract RemoteVisualStudioVersion remoteDebuggingVersion()
abstract void resetSlotConfigurations()

Reset the slot to its original configurations.

abstract Mono<Void> resetSlotConfigurationsAsync()

Reset the slot to its original configurations.

abstract void restart()

Restarts the web app or deployment slot.

abstract Mono<Void> restartAsync()

Restarts the web app or deployment slot.

abstract ScmType scmType()
abstract void start()

Starts the web app or deployment slot.

abstract Mono<Void> startAsync()

Starts the web app or deployment slot.

abstract void stop()

Stops the web app or deployment slot.

abstract Mono<Void> stopAsync()

Stops the web app or deployment slot.

abstract InputStream streamAllLogs()
abstract Flux<String> streamAllLogsAsync()
abstract InputStream streamApplicationLogs()
abstract Flux<String> streamApplicationLogsAsync()
abstract InputStream streamDeploymentLogs()
abstract Flux<String> streamDeploymentLogsAsync()
abstract InputStream streamHttpLogs()
abstract Flux<String> streamHttpLogsAsync()
abstract InputStream streamTraceLogs()
abstract Flux<String> streamTraceLogsAsync()
abstract void swap(String slotName)

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

abstract Mono<Void> swapAsync(String slotName)

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

abstract String systemAssignedManagedServiceIdentityPrincipalId()
abstract String systemAssignedManagedServiceIdentityTenantId()
abstract Set<String> userAssignedManagedServiceIdentityIds()
abstract void verifyDomainOwnership(String certificateOrderName, String domainVerificationToken)

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

abstract Mono<Void> verifyDomainOwnershipAsync(String certificateOrderName, String domainVerificationToken)

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

abstract List<VirtualApplication> virtualApplications()
abstract boolean webSocketsEnabled()
abstract String windowsFxVersion()
abstract void zipDeploy(File zipFile)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

abstract void zipDeploy(InputStream zipFile, long length)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

abstract Mono<Void> zipDeployAsync(File zipFile)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

abstract Mono<Void> zipDeployAsync(InputStream zipFile, long length)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

Method Details

alwaysOn

public abstract boolean alwaysOn()

Returns:

if the web app is always on

applySlotConfigurations

public abstract void applySlotConfigurations(String slotName)

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

Parameters:

slotName - the target slot to apply configurations from

applySlotConfigurationsAsync

public abstract Mono applySlotConfigurationsAsync(String slotName)

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

Parameters:

slotName - the target slot to apply configurations from

Returns:

a representation of the deferred computation of this call

autoSwapSlotName

public abstract String autoSwapSlotName()

Returns:

the auto swap slot name

defaultDocuments

public abstract List defaultDocuments()

Returns:

the default documents

deploy

public abstract WebDeployment.DefinitionStages.WithPackageUri deploy()

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

Returns:

a stage to create web deployment

diagnosticLogsConfig

public abstract WebAppDiagnosticLogs diagnosticLogsConfig()

Returns:

the diagnostic logs configuration

documentRoot

public abstract String documentRoot()

Returns:

the root directory for the web app

ftpsState

public abstract FtpsState ftpsState()

Returns:

the state of FTP / FTPS service

getAppSettings

public abstract Map getAppSettings()

Returns:

the app settings defined on the web app

getAppSettingsAsync

public abstract Mono<>> getAppSettingsAsync()

Returns:

the app settings defined on the web app

getAuthenticationConfig

public abstract WebAppAuthentication getAuthenticationConfig()

Returns:

the authentication configuration defined on the web app

getAuthenticationConfigAsync

public abstract Mono getAuthenticationConfigAsync()

Returns:

the authentication configuration defined on the web app

getConnectionStrings

public abstract Map getConnectionStrings()

Returns:

the connection strings defined on the web app

getConnectionStringsAsync

public abstract Mono<>> getConnectionStringsAsync()

Returns:

the connection strings defined on the web app

getContainerLogs

public abstract byte[] getContainerLogs()

Returns:

the last lines of docker logs for a Linux web app

getContainerLogsAsync

public abstract Mono getContainerLogsAsync()

Returns:

the last lines of docker logs for a Linux web app

getContainerLogsZip

public abstract byte[] getContainerLogsZip()

Returns:

the zipped archive of docker logs for a Linux web app

getContainerLogsZipAsync

public abstract Mono getContainerLogsZipAsync()

Returns:

the zipped archive of docker logs for a Linux web app

getHostnameBindings

public abstract Map getHostnameBindings()

Returns:

the mapping from host names and the host name bindings

getHostnameBindingsAsync

public abstract Mono<>> getHostnameBindingsAsync()

Returns:

the mapping from host names and the host name bindings

getPublishingProfile

public abstract PublishingProfile getPublishingProfile()

Returns:

the URL and credentials for publishing through FTP or Git

getPublishingProfileAsync

public abstract Mono getPublishingProfileAsync()

Returns:

the URL and credentials for publishing through FTP or Git

getSiteAppSettings

public abstract Map getSiteAppSettings()

Gets the App Settings on site from Kudu client. It might lag after App Setting update to the site.

Returns:

the App Settings on site from Kudu client

getSiteAppSettingsAsync

public abstract Mono<>> getSiteAppSettingsAsync()

Gets the App Settings on site from Kudu client. It might lag after App Setting update to the site.

Returns:

the App Settings on site from Kudu client

getSourceControl

public abstract WebAppSourceControl getSourceControl()

Returns:

the source control information for the web app

getSourceControlAsync

public abstract Mono getSourceControlAsync()

Returns:

the source control information for the web app

http20Enabled

public abstract boolean http20Enabled()

Returns:

whether to allow clients to connect over http2.0

ipSecurityRules

public abstract List ipSecurityRules()

Returns:

the list of ip security rules.

javaContainer

public abstract String javaContainer()

Returns:

Java container

javaContainerVersion

public abstract String javaContainerVersion()

Returns:

Java container version

javaVersion

public abstract JavaVersion javaVersion()

Returns:

Java version

linuxFxVersion

public abstract String linuxFxVersion()

Returns:

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

localMySqlEnabled

public abstract boolean localMySqlEnabled()

Returns:

whether local MySQL is enabled

managedPipelineMode

public abstract ManagedPipelineMode managedPipelineMode()

Returns:

managed pipeline mode

minTlsVersion

public abstract SupportedTlsVersions minTlsVersion()

Returns:

the minimum version of TLS required for SSL requests.

netFrameworkVersion

public abstract NetFrameworkVersion netFrameworkVersion()

Returns:

the .NET Framework version

nodeVersion

public abstract String nodeVersion()

Returns:

the version of Node.JS

phpVersion

public abstract PhpVersion phpVersion()

Returns:

the version of PHP

platformArchitecture

public abstract PlatformArchitecture platformArchitecture()

Returns:

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

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Whether the web app can be accessed from public network.

Returns:

whether the web app can be accessed from public network.

pythonVersion

public abstract PythonVersion pythonVersion()

Returns:

the version of Python

remoteDebuggingEnabled

public abstract boolean remoteDebuggingEnabled()

Returns:

if the remote eebugging is enabled

remoteDebuggingVersion

public abstract RemoteVisualStudioVersion remoteDebuggingVersion()

Returns:

the remote debugging version

resetSlotConfigurations

public abstract void resetSlotConfigurations()

Reset the slot to its original configurations.

resetSlotConfigurationsAsync

public abstract Mono resetSlotConfigurationsAsync()

Reset the slot to its original configurations.

Returns:

a representation of the deferred computation of this call

restart

public abstract void restart()

Restarts the web app or deployment slot.

restartAsync

public abstract Mono restartAsync()

Restarts the web app or deployment slot.

Returns:

a representation of the deferred computation of this call

scmType

public abstract ScmType scmType()

Returns:

the SCM configuration for the web app

start

public abstract void start()

Starts the web app or deployment slot.

startAsync

public abstract Mono startAsync()

Starts the web app or deployment slot.

Returns:

a representation of the deferred computation of this call

stop

public abstract void stop()

Stops the web app or deployment slot.

stopAsync

public abstract Mono stopAsync()

Stops the web app or deployment slot.

Returns:

a representation of the deferred computation of this call

streamAllLogs

public abstract InputStream streamAllLogs()

Returns:

a open stream to all logs

streamAllLogsAsync

public abstract Flux streamAllLogsAsync()

Returns:

an Observable streaming all logs

streamApplicationLogs

public abstract InputStream streamApplicationLogs()

Returns:

a open stream to the application logs

streamApplicationLogsAsync

public abstract Flux streamApplicationLogsAsync()

Returns:

an Observable streaming application logs

streamDeploymentLogs

public abstract InputStream streamDeploymentLogs()

Returns:

a open stream to the deployment logs

streamDeploymentLogsAsync

public abstract Flux streamDeploymentLogsAsync()

Returns:

an Observable streaming deployment logs

streamHttpLogs

public abstract InputStream streamHttpLogs()

Returns:

a open stream to the HTTP logs

streamHttpLogsAsync

public abstract Flux streamHttpLogsAsync()

Returns:

an Observable streaming HTTP logs

streamTraceLogs

public abstract InputStream streamTraceLogs()

Returns:

a open stream to the trace logs

streamTraceLogsAsync

public abstract Flux streamTraceLogsAsync()

Returns:

an Observable streaming trace logs

swap

public abstract void swap(String slotName)

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

Parameters:

slotName - the target slot to swap with. Use 'production' for the production slot.

swapAsync

public abstract Mono swapAsync(String slotName)

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

Parameters:

slotName - the target slot to swap with. Use 'production' for the production slot.

Returns:

a representation of the deferred computation of this call

systemAssignedManagedServiceIdentityPrincipalId

public abstract String systemAssignedManagedServiceIdentityPrincipalId()

Returns:

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

systemAssignedManagedServiceIdentityTenantId

public abstract String systemAssignedManagedServiceIdentityTenantId()

Returns:

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

userAssignedManagedServiceIdentityIds

public abstract Set userAssignedManagedServiceIdentityIds()

Returns:

The ids of the user assigned identities

verifyDomainOwnership

public abstract void verifyDomainOwnership(String certificateOrderName, String domainVerificationToken)

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

Parameters:

certificateOrderName - the name of the certificate order
domainVerificationToken - the domain verification token for the certificate order

verifyDomainOwnershipAsync

public abstract Mono verifyDomainOwnershipAsync(String certificateOrderName, String domainVerificationToken)

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

Parameters:

certificateOrderName - the name of the certificate order
domainVerificationToken - the domain verification token for the certificate order

Returns:

a representation of the deferred computation of this call

virtualApplications

public abstract List virtualApplications()

Returns:

the virtual applications and their virtual directories in this web app

webSocketsEnabled

public abstract boolean webSocketsEnabled()

Returns:

if web socket is enabled

windowsFxVersion

public abstract String windowsFxVersion()

Returns:

the Windows app framework and version if this is a Windows web app.

zipDeploy

public abstract void zipDeploy(File zipFile)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

Parameters:

zipFile - the ZIP file to upload

zipDeploy

public abstract void zipDeploy(InputStream zipFile, long length)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

Retry by client is required if error happens, due to nature of the stream.

Parameters:

zipFile - the ZIP file to upload
length - the length of the file

zipDeployAsync

public abstract Mono zipDeployAsync(File zipFile)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

Parameters:

zipFile - the ZIP file to upload

Returns:

a completable of the operation

zipDeployAsync

public abstract Mono zipDeployAsync(InputStream zipFile, long length)

Deploys a ZIP file onto the Azure specialized Java SE image on this web app.

Retry by client is required if error happens, due to nature of the stream.

Parameters:

zipFile - the ZIP file to upload
length - the length of the file

Returns:

a completable of the operation

Applies to