Package com.azure.resourcemanager.appservice.models

Interface WebAppBase

All Superinterfaces:
GroupableResource<AppServiceManager,SiteInner>, HasId, HasInnerModel<SiteInner>, HasManager<AppServiceManager>, HasName, HasResourceGroup, Indexable, Resource, WebSiteBase
All Known Subinterfaces:
DeploymentSlot, DeploymentSlotBase<FluentT>, FunctionApp, FunctionDeploymentSlot, WebApp
public interface WebAppBase extends HasName, GroupableResource<AppServiceManager,SiteInner>, WebSiteBase
An immutable client-side representation of an Azure Web App or deployment slot.

  • Method Details

    • defaultDocuments

      List<String> defaultDocuments()
      Gets the default documents.
      Returns:
      the default documents

    • netFrameworkVersion

      NetFrameworkVersion netFrameworkVersion()
      Gets the .NET Framework version.
      Returns:
      the .NET Framework version

    • phpVersion

      PhpVersion phpVersion()
      Gets the version of PHP.
      Returns:
      the version of PHP

    • pythonVersion

      PythonVersion pythonVersion()
      Gets the version of Python.
      Returns:
      the version of Python

    • nodeVersion

      String nodeVersion()
      Gets the version of Node.JS.
      Returns:
      the version of Node.JS

    • remoteDebuggingEnabled

      boolean remoteDebuggingEnabled()
      Check whether the remote eebugging is enabled.
      Returns:
      if the remote eebugging is enabled

    • remoteDebuggingVersion

      RemoteVisualStudioVersion remoteDebuggingVersion()
      Gets the remote debugging version.
      Returns:
      the remote debugging version

    • webSocketsEnabled

      boolean webSocketsEnabled()
      Check whether web socket is enabled.
      Returns:
      if web socket is enabled

    • alwaysOn

      boolean alwaysOn()
      Check whether the web app is always on.
      Returns:
      if the web app is always on

    • javaVersion

      JavaVersion javaVersion()
      Gets Java version.
      Returns:
      Java version

    • javaContainer

      String javaContainer()
      Gets Java container.
      Returns:
      Java container

    • javaContainerVersion

      String javaContainerVersion()
      Gets Java container version.
      Returns:
      Java container version

    • managedPipelineMode

      ManagedPipelineMode managedPipelineMode()
      Gets managed pipeline mode.
      Returns:
      managed pipeline mode

    • autoSwapSlotName

      String autoSwapSlotName()
      Gets the auto swap slot name.
      Returns:
      the auto swap slot name

    • ftpsState

      FtpsState ftpsState()
      Gets the state of FTP / FTPS service.
      Returns:
      the state of FTP / FTPS service

    • virtualApplications

      List<VirtualApplication> virtualApplications()
      Gets the virtual applications and their virtual directories in this web app.
      Returns:
      the virtual applications and their virtual directories in this web app

    • http20Enabled

      boolean http20Enabled()
      Check whether to allow clients to connect over HTTP/2.
      Returns:
      whether to allow clients to connect over HTTP/2

    • minTlsVersion

      SupportedTlsVersions minTlsVersion()
      Gets the minimum version of TLS required for SSL requests.
      Returns:
      the minimum version of TLS required for SSL requests.

    • localMySqlEnabled

      boolean localMySqlEnabled()
      Check whether local MySQL is enabled.
      Returns:
      whether local MySQL is enabled

    • scmType

      ScmType scmType()
      Gets the SCM configuration for the web app.
      Returns:
      the SCM configuration for the web app

    • documentRoot

      String documentRoot()
      Gets the root directory for the web app.
      Returns:
      the root directory for the web app

    • systemAssignedManagedServiceIdentityTenantId

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

    • systemAssignedManagedServiceIdentityPrincipalId

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

    • userAssignedManagedServiceIdentityIds

      Set<String> userAssignedManagedServiceIdentityIds()
      Gets the ids of the user assigned identities .
      Returns:
      The ids of the user assigned identities

    • getAppSettings

      Map<String,AppSetting> getAppSettings()
      Gets the app settings defined on the web app
      Returns:
      the app settings defined on the web app

    • getAppSettingsAsync

      Mono<Map<String,AppSetting>> getAppSettingsAsync()
      Gets the app settings defined on the web app.
      Returns:
      the app settings defined on the web app

    • getConnectionStrings

      Map<String,ConnectionString> getConnectionStrings()
      Gets the connection strings defined on the web app.
      Returns:
      the connection strings defined on the web app

    • getConnectionStringsAsync

      Mono<Map<String,ConnectionString>> getConnectionStringsAsync()
      Gets the connection strings defined on the web app.
      Returns:
      the connection strings defined on the web app

    • getAuthenticationConfig

      WebAppAuthentication getAuthenticationConfig()
      Gets the authentication configuration defined on the web app.
      Returns:
      the authentication configuration defined on the web app

    • getAuthenticationConfigAsync

      Mono<WebAppAuthentication> getAuthenticationConfigAsync()
      Gets the authentication configuration defined on the web app.
      Returns:
      the authentication configuration defined on the web app

    • platformArchitecture

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

    • linuxFxVersion

      String linuxFxVersion()
      Gets the Linux app framework and version if this is a Linux web app.
      Returns:
      the Linux app framework and version if this is a Linux web app.

    • windowsFxVersion

      String windowsFxVersion()
      Gets the Windows app framework and version if this is a Windows web app.
      Returns:
      the Windows app framework and version if this is a Windows web app.

    • ipSecurityRules

      List<IpSecurityRestriction> ipSecurityRules()
      Gets the list of ip security rules.
      Returns:
      the list of ip security rules.

    • diagnosticLogsConfig

      WebAppDiagnosticLogs diagnosticLogsConfig()
      Gets the diagnostic logs configuration.
      Returns:
      the diagnostic logs configuration

    • getHostnameBindings

      Map<String,HostnameBinding> getHostnameBindings()
      Gets the mapping from host names and the host name bindings.
      Returns:
      the mapping from host names and the host name bindings

    • getHostnameBindingsAsync

      Mono<Map<String,HostnameBinding>> getHostnameBindingsAsync()
      Gets the mapping from host names and the host name bindings.
      Returns:
      the mapping from host names and the host name bindings

    • getPublishingProfile

      PublishingProfile getPublishingProfile()
      Gets the URL and credentials for publishing through FTP or Git.
      Returns:
      the URL and credentials for publishing through FTP or Git

    • getPublishingProfileAsync

      Mono<PublishingProfile> getPublishingProfileAsync()
      Gets the URL and credentials for publishing through FTP or Git.
      Returns:
      the URL and credentials for publishing through FTP or Git

    • getSourceControl

      WebAppSourceControl getSourceControl()
      Gets the source control information for the web app.
      Returns:
      the source control information for the web app

    • getSourceControlAsync

      Mono<WebAppSourceControl> getSourceControlAsync()
      Gets the source control information for the web app.
      Returns:
      the source control information for the web app

    • deploy

      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

    • getContainerLogs

      byte[] getContainerLogs()
      Gets the last lines of docker logs for a Linux web app.
      Returns:
      the last lines of docker logs for a Linux web app

    • getContainerLogsAsync

      Mono<byte[]> getContainerLogsAsync()
      Gets the last lines of docker logs for a Linux web app.
      Returns:
      the last lines of docker logs for a Linux web app

    • getContainerLogsZip

      byte[] getContainerLogsZip()
      Gets the zipped archive of docker logs for a Linux web app.
      Returns:
      the zipped archive of docker logs for a Linux web app

    • getContainerLogsZipAsync

      Mono<byte[]> getContainerLogsZipAsync()
      Gets the zipped archive of docker logs for a Linux web app.
      Returns:
      the zipped archive of docker logs for a Linux web app

    • streamApplicationLogs

      InputStream streamApplicationLogs()
      Gets a open stream to the application logs.
      Returns:
      a open stream to the application logs

    • streamHttpLogs

      InputStream streamHttpLogs()
      Gets a open stream to the HTTP logs.
      Returns:
      a open stream to the HTTP logs

    • streamTraceLogs

      InputStream streamTraceLogs()
      Gets a open stream to the trace logs.
      Returns:
      a open stream to the trace logs

    • streamDeploymentLogs

      InputStream streamDeploymentLogs()
      Gets a open stream to the deployment logs.
      Returns:
      a open stream to the deployment logs

    • streamAllLogs

      InputStream streamAllLogs()
      Gets an open stream to all logs.
      Returns:
      an open stream to all logs

    • streamApplicationLogsAsync

      Flux<String> streamApplicationLogsAsync()
      Gets an Observable streaming application logs.
      Returns:
      an Observable streaming application logs

    • streamHttpLogsAsync

      Flux<String> streamHttpLogsAsync()
      Gets an Observable streaming HTTP logs
      Returns:
      an Observable streaming HTTP logs

    • streamTraceLogsAsync

      Flux<String> streamTraceLogsAsync()
      Gets an Observable streaming trace logs.
      Returns:
      an Observable streaming trace logs

    • streamDeploymentLogsAsync

      Flux<String> streamDeploymentLogsAsync()
      Gets an Observable streaming deployment logs.
      Returns:
      an Observable streaming deployment logs

    • streamAllLogsAsync

      Flux<String> streamAllLogsAsync()
      Gets an Observable streaming all logs.
      Returns:
      an Observable streaming all logs

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Whether the web app can be accessed from public network.
      Returns:
      whether the web app can be accessed from public network.

    • verifyDomainOwnership

      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

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

    • start

      void start()
      Starts the web app or deployment slot.

    • startAsync

      Mono<Void> startAsync()
      Starts the web app or deployment slot.
      Returns:
      a representation of the deferred computation of this call

    • stop

      void stop()
      Stops the web app or deployment slot.

    • stopAsync

      Mono<Void> stopAsync()
      Stops the web app or deployment slot.
      Returns:
      a representation of the deferred computation of this call

    • restart

      void restart()
      Restarts the web app or deployment slot.

    • restartAsync

      Mono<Void> restartAsync()
      Restarts the web app or deployment slot.
      Returns:
      a representation of the deferred computation of this call

    • swap

      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

      Mono<Void> 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

    • applySlotConfigurations

      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

      Mono<Void> 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

    • resetSlotConfigurations

      void resetSlotConfigurations()
      Reset the slot to its original configurations.

    • resetSlotConfigurationsAsync

      Mono<Void> resetSlotConfigurationsAsync()
      Reset the slot to its original configurations.
      Returns:
      a representation of the deferred computation of this call

    • zipDeploy

      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

    • zipDeployAsync

      Mono<Void> 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

    • zipDeploy

      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

      Mono<Void> 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

    • getSiteAppSettings

      Map<String,String> 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

      Mono<Map<String,String>> 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