Interface WebAppBase

    • Method Detail

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

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

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

        Mono<WebAppAuthentication> getAuthenticationConfigAsync()
        Returns:
        the authentication configuration defined on the web app
      • 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.
      • windowsFxVersion

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

        WebAppDiagnosticLogs diagnosticLogsConfig()
        Returns:
        the diagnostic logs configuration
      • getHostnameBindings

        Map<String,​HostnameBinding> getHostnameBindings()
        Returns:
        the mapping from host names and the host name bindings
      • getHostnameBindingsAsync

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

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

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

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

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

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

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

        InputStream streamApplicationLogs()
        Returns:
        a open stream to the application logs
      • streamHttpLogs

        InputStream streamHttpLogs()
        Returns:
        a open stream to the HTTP logs
      • streamTraceLogs

        InputStream streamTraceLogs()
        Returns:
        a open stream to the trace logs
      • streamDeploymentLogs

        InputStream streamDeploymentLogs()
        Returns:
        a open stream to the deployment logs
      • streamAllLogs

        InputStream streamAllLogs()
        Returns:
        a open stream to all logs
      • streamApplicationLogsAsync

        Flux<String> streamApplicationLogsAsync()
        Returns:
        an Observable streaming application logs
      • streamHttpLogsAsync

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

        Flux<String> streamTraceLogsAsync()
        Returns:
        an Observable streaming trace logs
      • streamDeploymentLogsAsync

        Flux<String> streamDeploymentLogsAsync()
        Returns:
        an Observable streaming deployment logs
      • streamAllLogsAsync

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

        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