Package com.microsoft.azure.management.appservice

Interface WebAppBase

All Superinterfaces:
GroupableResource<com.microsoft.azure.management.appservice.implementation.AppServiceManager,com.microsoft.azure.management.appservice.implementation.SiteInner>, HasId, HasInner<com.microsoft.azure.management.appservice.implementation.SiteInner>, HasManager<com.microsoft.azure.management.appservice.implementation.AppServiceManager>, HasName, HasResourceGroup, Indexable, Resource
All Known Subinterfaces:
DeploymentSlot, DeploymentSlotBase<FluentT>, FunctionApp, FunctionDeploymentSlot, WebApp
@Beta public interface WebAppBase extends HasName, GroupableResource<com.microsoft.azure.management.appservice.implementation.AppServiceManager,com.microsoft.azure.management.appservice.implementation.SiteInner>
An immutable client-side representation of an Azure Web App or deployment slot.

  • Method Details

    • state

      String state()
      Returns:
      state of the web app

    • hostNames

      Set<String> hostNames()
      Returns:
      hostnames associated with web app

    • repositorySiteName

      String repositorySiteName()
      Returns:
      name of repository site

    • usageState

      UsageState usageState()
      Returns:
      state indicating whether web app has exceeded its quota usage

    • enabled

      boolean enabled()
      Returns:
      true if the site is enabled; otherwise, false

    • enabledHostNames

      Set<String> enabledHostNames()
      Returns:
      host names for the web app that are enabled

    • availabilityState

      SiteAvailabilityState availabilityState()
      Returns:
      management information availability state for the web app

    • hostNameSslStates

      Map<String,HostNameSslState> hostNameSslStates()
      Returns:
      list of SSL states used to manage the SSL bindings for site's hostnames

    • appServicePlanId

      String appServicePlanId()
      Returns:
      The resource ID of the app service plan

    • lastModifiedTime

      org.joda.time.DateTime lastModifiedTime()
      Returns:
      Last time web app was modified in UTC

    • trafficManagerHostNames

      Set<String> trafficManagerHostNames()
      Returns:
      list of Azure Traffic manager host names associated with web app

    • scmSiteAlsoStopped

      boolean scmSiteAlsoStopped()
      Returns:
      whether to stop SCM (KUDU) site when the web app is stopped. Default is false.

    • targetSwapSlot

      String targetSwapSlot()
      Returns:
      which slot this app will swap into

    • clientAffinityEnabled

      boolean clientAffinityEnabled()
      Returns:
      if the client affinity is enabled when load balancing http request for multiple instances of the web app

    • clientCertEnabled

      boolean clientCertEnabled()
      Returns:
      if the client certificate is enabled for the web app

    • hostNamesDisabled

      boolean hostNamesDisabled()
      Returns:
      if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process.

    • outboundIPAddresses

      Set<String> outboundIPAddresses()
      Returns:
      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.

    • containerSize

      int containerSize()
      Returns:
      size of a function container

    • cloningInfo

      CloningInfo cloningInfo()
      Returns:
      information about whether the web app is cloned from another

    • isDefaultContainer

      boolean isDefaultContainer()
      Returns:
      site is a default container

    • defaultHostName

      String defaultHostName()
      Returns:
      default hostname of the web app

    • defaultDocuments

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

    • netFrameworkVersion

      NetFrameworkVersion netFrameworkVersion()
      Returns:
      the .NET Framework version

    • phpVersion

      PhpVersion phpVersion()
      Returns:
      the version of PHP

    • pythonVersion

      PythonVersion pythonVersion()
      Returns:
      the version of Python

    • nodeVersion

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

    • remoteDebuggingEnabled

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

    • remoteDebuggingVersion

      RemoteVisualStudioVersion remoteDebuggingVersion()
      Returns:
      the remote debugging version

    • webSocketsEnabled

      boolean webSocketsEnabled()
      Returns:
      if web socket is enabled

    • alwaysOn

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

    • javaVersion

      JavaVersion javaVersion()
      Returns:
      Java version

    • javaContainer

      String javaContainer()
      Returns:
      Java container

    • javaContainerVersion

      String javaContainerVersion()
      Returns:
      Java container version

    • managedPipelineMode

      ManagedPipelineMode managedPipelineMode()
      Returns:
      managed pipeline mode

    • autoSwapSlotName

      String autoSwapSlotName()
      Returns:
      the auto swap slot name

    • httpsOnly

      boolean httpsOnly()
      Returns:
      true if the web app is configured to accept only HTTPS requests. HTTP requests will be redirected.

    • ftpsState

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

    • virtualApplications

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

    • http20Enabled

      boolean http20Enabled()
      Returns:
      whether to allow clients to connect over http2.0

    • minTlsVersion

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

    • localMySqlEnabled

      boolean localMySqlEnabled()
      Returns:
      whether local MySQL is enabled

    • scmType

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

    • documentRoot

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

    • systemAssignedManagedServiceIdentityTenantId

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

    • systemAssignedManagedServiceIdentityPrincipalId

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

    • userAssignedManagedServiceIdentityIds

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

    • getAppSettings

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

    • getAppSettingsAsync

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

    • getConnectionStrings

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

    • getConnectionStringsAsync

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

    • getAuthenticationConfig

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

    • getAuthenticationConfigAsync

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

    • operatingSystem

      OperatingSystem operatingSystem()
      Returns:
      the operating system the web app is running on

    • platformArchitecture

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

    • linuxFxVersion

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

    • diagnosticLogsConfig

      @Beta(V1_18_0) WebAppDiagnosticLogs diagnosticLogsConfig()
      Returns:
      the diagnostic logs configuration

    • getHostNameBindings

      Map<String,HostNameBinding> getHostNameBindings()
      Returns:
      the mapping from host names and the host name bindings

    • getHostNameBindingsAsync

      rx.Observable<Map<String,HostNameBinding>> getHostNameBindingsAsync()
      Returns:
      the mapping from host names and the host name bindings

    • getPublishingProfile

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

    • getPublishingProfileAsync

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

    • getSourceControl

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

    • getSourceControlAsync

      rx.Observable<WebAppSourceControl> getSourceControlAsync()
      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

      @Beta(V1_5_0) byte[] getContainerLogs()
      Returns:
      the last lines of docker logs for a Linux web app

    • getContainerLogsAsync

      @Beta(V1_5_0) rx.Observable<byte[]> getContainerLogsAsync()
      Returns:
      the last lines of docker logs for a Linux web app

    • getContainerLogsZip

      @Beta(V1_5_0) byte[] getContainerLogsZip()
      Returns:
      the zipped archive of docker logs for a Linux web app

    • getContainerLogsZipAsync

      @Beta(V1_5_0) rx.Observable<byte[]> getContainerLogsZipAsync()
      Returns:
      the zipped archive of docker logs for a Linux web app

    • streamApplicationLogs

      @Beta(V1_6_0) InputStream streamApplicationLogs()
      Returns:
      a open stream to the application logs

    • streamHttpLogs

      @Beta(V1_18_0) InputStream streamHttpLogs()
      Returns:
      a open stream to the HTTP logs

    • streamTraceLogs

      @Beta(V1_18_0) InputStream streamTraceLogs()
      Returns:
      a open stream to the trace logs

    • streamDeploymentLogs

      @Beta(V1_18_0) InputStream streamDeploymentLogs()
      Returns:
      a open stream to the deployment logs

    • streamAllLogs

      @Beta(V1_18_0) InputStream streamAllLogs()
      Returns:
      a open stream to all logs

    • streamApplicationLogsAsync

      @Beta(V1_6_0) rx.Observable<String> streamApplicationLogsAsync()
      Returns:
      an Observable streaming application logs

    • streamHttpLogsAsync

      @Beta(V1_18_0) rx.Observable<String> streamHttpLogsAsync()
      Returns:
      an Observable streaming HTTP logs

    • streamTraceLogsAsync

      @Beta(V1_18_0) rx.Observable<String> streamTraceLogsAsync()
      Returns:
      an Observable streaming trace logs

    • streamDeploymentLogsAsync

      @Beta(V1_18_0) rx.Observable<String> streamDeploymentLogsAsync()
      Returns:
      an Observable streaming deployment logs

    • streamAllLogsAsync

      @Beta(V1_18_0) rx.Observable<String> streamAllLogsAsync()
      Returns:
      an Observable streaming all logs

    • 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

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

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

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

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

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

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

      rx.Completable resetSlotConfigurationsAsync()
      Reset the slot to its original configurations.
      Returns:
      a representation of the deferred computation of this call

    • zipDeploy

      @Beta(V1_14_0) 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

      @Beta(V1_14_0) rx.Completable 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

      @Beta(V1_14_0) void zipDeploy(InputStream zipFile)
      Deploys a ZIP file onto the Azure specialized Java SE image on this web app.
      Parameters:
      zipFile - the ZIP file to upload

    • zipDeployAsync

      @Beta(V1_14_0) rx.Completable zipDeployAsync(InputStream 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

    • getSiteAppSettings

      @Beta(V1_37_0) 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

      @Beta(V1_37_0) rx.Observable<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