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()
Check whether the web app is always on. |
| 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()
Gets the auto swap slot name. |
| abstract List<String> |
defaultDocuments()
Gets the default documents. |
|
abstract
With |
deploy()
First step specifying the parameters to make a web deployment (MS Deploy) to the web app. |
|
abstract
Web |
diagnosticLogsConfig()
Gets the diagnostic logs configuration. |
| abstract String |
documentRoot()
Gets the root directory for the web app. |
|
abstract
Ftps |
ftpsState()
Gets the state of FTP / FTPS service. |
|
abstract
Map<String,App |
getAppSettings()
Gets the app settings defined on the web app |
|
abstract
Mono<Map<String,App |
getAppSettingsAsync()
Gets the app settings defined on the web app. |
|
abstract
Web |
getAuthenticationConfig()
Gets the authentication configuration defined on the web app. |
|
abstract
Mono<Web |
getAuthenticationConfigAsync()
Gets the authentication configuration defined on the web app. |
|
abstract
Map<String,Connection |
getConnectionStrings()
Gets the connection strings defined on the web app. |
|
abstract
Mono<Map<String,Connection |
getConnectionStringsAsync()
Gets the connection strings defined on the web app. |
| abstract byte[] |
getContainerLogs()
Gets the last lines of docker logs for a Linux web app. |
| abstract Mono<byte[]> |
getContainerLogsAsync()
Gets the last lines of docker logs for a Linux web app. |
| abstract byte[] |
getContainerLogsZip()
Gets the zipped archive of docker logs for a Linux web app. |
| abstract Mono<byte[]> |
getContainerLogsZipAsync()
Gets the zipped archive of docker logs for a Linux web app. |
|
abstract
Map<String,Hostname |
getHostnameBindings()
Gets the mapping from host names and the host name bindings. |
|
abstract
Mono<Map<String,Hostname |
getHostnameBindingsAsync()
Gets the mapping from host names and the host name bindings. |
|
abstract
Publishing |
getPublishingProfile()
Gets the URL and credentials for publishing through FTP or Git. |
|
abstract
Mono<Publishing |
getPublishingProfileAsync()
Gets the URL and credentials for publishing through FTP or Git. |
| 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
Web |
getSourceControl()
Gets the source control information for the web app. |
|
abstract
Mono<Web |
getSourceControlAsync()
Gets the source control information for the web app. |
| abstract boolean |
http20Enabled()
Check whether to allow clients to connect over HTTP/2. |
|
abstract
List<Ip |
ipSecurityRules()
Gets the list of ip security rules. |
| abstract String |
javaContainer()
Gets Java container. |
| abstract String |
javaContainerVersion()
Gets Java container version. |
|
abstract
Java |
javaVersion()
Gets Java version. |
| abstract String |
linuxFxVersion()
Gets the Linux app framework and version if this is a Linux web app. |
| abstract boolean |
localMySqlEnabled()
Check whether local MySQL is enabled. |
|
abstract
Managed |
managedPipelineMode()
Gets managed pipeline mode. |
|
abstract
Supported |
minTlsVersion()
Gets the minimum version of TLS required for SSL requests. |
|
abstract
Net |
netFrameworkVersion()
Gets the .NET Framework version. |
| abstract String |
nodeVersion()
Gets the version of Node. |
|
abstract
Php |
phpVersion()
Gets the version of PHP. |
|
abstract
Platform |
platformArchitecture()
Gets the architecture of the platform. |
|
abstract
Public |
publicNetworkAccess()
Whether the web app can be accessed from public network. |
|
abstract
Python |
pythonVersion()
Gets the version of Python. |
| abstract boolean |
remoteDebuggingEnabled()
Check whether the remote eebugging is enabled. |
|
abstract
Remote |
remoteDebuggingVersion()
Gets the remote debugging version. |
| 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
Scm |
scmType()
Gets the SCM configuration for the web app. |
| 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
Input |
streamAllLogs()
Gets an open stream to all logs. |
| abstract Flux<String> |
streamAllLogsAsync()
Gets an Observable streaming all logs. |
|
abstract
Input |
streamApplicationLogs()
Gets a open stream to the application logs. |
| abstract Flux<String> |
streamApplicationLogsAsync()
Gets an Observable streaming application logs. |
|
abstract
Input |
streamDeploymentLogs()
Gets a open stream to the deployment logs. |
| abstract Flux<String> |
streamDeploymentLogsAsync()
Gets an Observable streaming deployment logs. |
|
abstract
Input |
streamHttpLogs()
Gets a open stream to the HTTP logs. |
| abstract Flux<String> |
streamHttpLogsAsync()
Gets an Observable streaming HTTP logs |
|
abstract
Input |
streamTraceLogs()
Gets a open stream to the trace logs. |
| abstract Flux<String> |
streamTraceLogsAsync()
Gets an Observable streaming trace logs. |
| 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()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the web app. |
| abstract String |
systemAssignedManagedServiceIdentityTenantId()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the web app. |
| abstract Set<String> |
userAssignedManagedServiceIdentityIds()
Gets the ids of the user assigned identities . |
| 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<Virtual |
virtualApplications()
Gets the virtual applications and their virtual directories in this web app. |
| abstract boolean |
webSocketsEnabled()
Check whether web socket is enabled. |
| abstract String |
windowsFxVersion()
Gets the Windows app framework and version if this is a Windows web app. |
| 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()
Check whether the web app is always on.
Returns:
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:
applySlotConfigurationsAsync
public abstract Mono
Apply the slot (or sticky) configurations from the specified slot to the current one. This is useful for "Swap with Preview".
Parameters:
Returns:
autoSwapSlotName
public abstract String autoSwapSlotName()
Gets the auto swap slot name.
Returns:
defaultDocuments
public abstract List
Gets the default documents.
Returns:
deploy
public abstract WebDeployment.DefinitionStages.WithPackageUri deploy()
First step specifying the parameters to make a web deployment (MS Deploy) to the web app.
Returns:
diagnosticLogsConfig
public abstract WebAppDiagnosticLogs diagnosticLogsConfig()
Gets the diagnostic logs configuration.
Returns:
documentRoot
public abstract String documentRoot()
Gets the root directory for the web app.
Returns:
ftpsState
public abstract FtpsState ftpsState()
Gets the state of FTP / FTPS service.
Returns:
getAppSettings
public abstract Map
Gets the app settings defined on the web app
Returns:
getAppSettingsAsync
public abstract Mono
Gets the app settings defined on the web app.
Returns:
getAuthenticationConfig
public abstract WebAppAuthentication getAuthenticationConfig()
Gets the authentication configuration defined on the web app.
Returns:
getAuthenticationConfigAsync
public abstract Mono
Gets the authentication configuration defined on the web app.
Returns:
getConnectionStrings
public abstract Map
Gets the connection strings defined on the web app.
Returns:
getConnectionStringsAsync
public abstract Mono
Gets the connection strings defined on the web app.
Returns:
getContainerLogs
public abstract byte[] getContainerLogs()
Gets the last lines of docker logs for a Linux web app.
Returns:
getContainerLogsAsync
public abstract Mono
Gets the last lines of docker logs for a Linux web app.
Returns:
getContainerLogsZip
public abstract byte[] getContainerLogsZip()
Gets the zipped archive of docker logs for a Linux web app.
Returns:
getContainerLogsZipAsync
public abstract Mono
Gets the zipped archive of docker logs for a Linux web app.
Returns:
getHostnameBindings
public abstract Map
Gets the mapping from host names and the host name bindings.
Returns:
getHostnameBindingsAsync
public abstract Mono
Gets the mapping from host names and the host name bindings.
Returns:
getPublishingProfile
public abstract PublishingProfile getPublishingProfile()
Gets the URL and credentials for publishing through FTP or Git.
Returns:
getPublishingProfileAsync
public abstract Mono
Gets the URL and credentials for publishing through FTP or Git.
Returns:
getSiteAppSettings
public abstract Map
Gets the App Settings on site from Kudu client. It might lag after App Setting update to the site.
Returns:
getSiteAppSettingsAsync
public abstract Mono
Gets the App Settings on site from Kudu client. It might lag after App Setting update to the site.
Returns:
getSourceControl
public abstract WebAppSourceControl getSourceControl()
Gets the source control information for the web app.
Returns:
getSourceControlAsync
public abstract Mono
Gets the source control information for the web app.
Returns:
http20Enabled
public abstract boolean http20Enabled()
Check whether to allow clients to connect over HTTP/2.
Returns:
ipSecurityRules
public abstract List
Gets the list of ip security rules.
Returns:
javaContainer
public abstract String javaContainer()
Gets Java container.
Returns:
javaContainerVersion
public abstract String javaContainerVersion()
Gets Java container version.
Returns:
javaVersion
public abstract JavaVersion javaVersion()
Gets Java version.
Returns:
linuxFxVersion
public abstract String linuxFxVersion()
Gets the Linux app framework and version if this is a Linux web app.
Returns:
localMySqlEnabled
public abstract boolean localMySqlEnabled()
Check whether local MySQL is enabled.
Returns:
managedPipelineMode
public abstract ManagedPipelineMode managedPipelineMode()
Gets managed pipeline mode.
Returns:
minTlsVersion
public abstract SupportedTlsVersions minTlsVersion()
Gets the minimum version of TLS required for SSL requests.
Returns:
netFrameworkVersion
public abstract NetFrameworkVersion netFrameworkVersion()
Gets the .NET Framework version.
Returns:
nodeVersion
public abstract String nodeVersion()
Gets the version of Node.JS.
Returns:
phpVersion
public abstract PhpVersion phpVersion()
Gets the version of PHP.
Returns:
platformArchitecture
public abstract PlatformArchitecture platformArchitecture()
Gets the architecture of the platform.
Returns:
publicNetworkAccess
public abstract PublicNetworkAccess publicNetworkAccess()
Whether the web app can be accessed from public network.
Returns:
pythonVersion
public abstract PythonVersion pythonVersion()
Gets the version of Python.
Returns:
remoteDebuggingEnabled
public abstract boolean remoteDebuggingEnabled()
Check whether the remote eebugging is enabled.
Returns:
remoteDebuggingVersion
public abstract RemoteVisualStudioVersion remoteDebuggingVersion()
Gets the remote debugging version.
Returns:
resetSlotConfigurations
public abstract void resetSlotConfigurations()
Reset the slot to its original configurations.
resetSlotConfigurationsAsync
public abstract Mono
Reset the slot to its original configurations.
Returns:
restart
public abstract void restart()
Restarts the web app or deployment slot.
restartAsync
public abstract Mono
Restarts the web app or deployment slot.
Returns:
scmType
public abstract ScmType scmType()
Gets the SCM configuration for the web app.
Returns:
start
public abstract void start()
Starts the web app or deployment slot.
startAsync
public abstract Mono
Starts the web app or deployment slot.
Returns:
stop
public abstract void stop()
Stops the web app or deployment slot.
stopAsync
public abstract Mono
Stops the web app or deployment slot.
Returns:
streamAllLogs
public abstract InputStream streamAllLogs()
Gets an open stream to all logs.
Returns:
streamAllLogsAsync
public abstract Flux
Gets an Observable streaming all logs.
Returns:
streamApplicationLogs
public abstract InputStream streamApplicationLogs()
Gets a open stream to the application logs.
Returns:
streamApplicationLogsAsync
public abstract Flux
Gets an Observable streaming application logs.
Returns:
streamDeploymentLogs
public abstract InputStream streamDeploymentLogs()
Gets a open stream to the deployment logs.
Returns:
streamDeploymentLogsAsync
public abstract Flux
Gets an Observable streaming deployment logs.
Returns:
streamHttpLogs
public abstract InputStream streamHttpLogs()
Gets a open stream to the HTTP logs.
Returns:
streamHttpLogsAsync
public abstract Flux
Gets an Observable streaming HTTP logs
Returns:
streamTraceLogs
public abstract InputStream streamTraceLogs()
Gets a open stream to the trace logs.
Returns:
streamTraceLogsAsync
public abstract Flux
Gets an Observable streaming trace logs.
Returns:
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:
swapAsync
public abstract Mono
Swaps the app running in the current web app / slot with the app running in the specified slot.
Parameters:
Returns:
systemAssignedManagedServiceIdentityPrincipalId
public abstract String systemAssignedManagedServiceIdentityPrincipalId()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the web app.
Returns:
systemAssignedManagedServiceIdentityTenantId
public abstract String systemAssignedManagedServiceIdentityTenantId()
Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the web app.
Returns:
userAssignedManagedServiceIdentityIds
public abstract Set
Gets the ids of the user assigned identities .
Returns:
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:
verifyDomainOwnershipAsync
public abstract Mono
Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app.
Parameters:
Returns:
virtualApplications
public abstract List
Gets the virtual applications and their virtual directories in this web app.
Returns:
webSocketsEnabled
public abstract boolean webSocketsEnabled()
Check whether web socket is enabled.
Returns:
windowsFxVersion
public abstract String windowsFxVersion()
Gets the Windows app framework and version if this is a Windows web app.
Returns:
zipDeploy
public abstract void zipDeploy(File zipFile)
Deploys a ZIP file onto the Azure specialized Java SE image on this web app.
Parameters:
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:
zipDeployAsync
public abstract Mono
Deploys a ZIP file onto the Azure specialized Java SE image on this web app.
Parameters:
Returns:
zipDeployAsync
public abstract Mono
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:
Returns:
Applies to
Azure SDK for Java