WebAppBase (Microsoft Azure SDK for App Service Management 1.3.0 API)

All Superinterfaces:

com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource<com.microsoft.azure.management.appservice.implementation.AppServiceManager,com.microsoft.azure.management.appservice.implementation.SiteInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasId, com.microsoft.azure.management.resources.fluentcore.model.HasInner<com.microsoft.azure.management.appservice.implementation.SiteInner>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<com.microsoft.azure.management.appservice.implementation.AppServiceManager>, com.microsoft.azure.management.resources.fluentcore.arm.models.HasName, com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup, com.microsoft.azure.management.resources.fluentcore.model.Indexable, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

All Known Subinterfaces:

DeploymentSlot, FunctionApp, FunctionDeploymentSlot, WebApp
```
@Beta
public interface WebAppBase
extends com.microsoft.azure.management.resources.fluentcore.arm.models.HasName, com.microsoft.azure.management.resources.fluentcore.arm.models.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.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`WebAppBase.Definition<FluentT>` The entirety of the web app base definition.
`static interface`	`WebAppBase.DefinitionStages` Grouping of all the site definition stages.
`static interface`	`WebAppBase.Update<FluentT>` The template for a site update operation, containing all the settings that can be modified.
`static interface`	`WebAppBase.UpdateStages` Grouping of all the web app update stages.

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource
com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.microsoft.azure.management.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`alwaysOn()`
`void`	`applySlotConfigurations(String slotName)` Apply the slot (or sticky) configurations from the specified slot to the current one.
`rx.Completable`	`applySlotConfigurationsAsync(String slotName)` Apply the slot (or sticky) configurations from the specified slot to the current one.
`String`	`appServicePlanId()`
`Map<String,AppSetting>`	`appSettings()`
`String`	`autoSwapSlotName()`
`SiteAvailabilityState`	`availabilityState()`
`boolean`	`clientAffinityEnabled()`
`boolean`	`clientCertEnabled()`
`CloningInfo`	`cloningInfo()`
`Map<String,ConnectionString>`	`connectionStrings()`
`int`	`containerSize()`
`List<String>`	`defaultDocuments()`
`String`	`defaultHostName()`
`WebDeployment.DefinitionStages.WithPackageUri`	`deploy()` First step specifying the parameters to make a web deployment (MS Deploy) to the web app.
`boolean`	`enabled()`
`Set<String>`	`enabledHostNames()`
`String`	`gatewaySiteName()`
`Map<String,HostNameBinding>`	`getHostNameBindings()`
`rx.Observable<Map<String,HostNameBinding>>`	`getHostNameBindingsAsync()`
`PublishingProfile`	`getPublishingProfile()`
`rx.Observable<PublishingProfile>`	`getPublishingProfileAsync()`
`WebAppSourceControl`	`getSourceControl()`
`rx.Observable<WebAppSourceControl>`	`getSourceControlAsync()`
`Set<String>`	`hostNames()`
`boolean`	`hostNamesDisabled()`
`Map<String,HostNameSslState>`	`hostNameSslStates()`
`boolean`	`isDefaultContainer()`
`boolean`	`isPremiumApp()`
`String`	`javaContainer()`
`String`	`javaContainerVersion()`
`JavaVersion`	`javaVersion()`
`org.joda.time.DateTime`	`lastModifiedTime()`
`String`	`linuxFxVersion()`
`ManagedPipelineMode`	`managedPipelineMode()`
`String`	`microService()`
`NetFrameworkVersion`	`netFrameworkVersion()`
`String`	`nodeVersion()`
`OperatingSystem`	`operatingSystem()`
`Set<String>`	`outboundIPAddresses()`
`PhpVersion`	`phpVersion()`
`PlatformArchitecture`	`platformArchitecture()`
`PythonVersion`	`pythonVersion()`
`boolean`	`remoteDebuggingEnabled()`
`RemoteVisualStudioVersion`	`remoteDebuggingVersion()`
`String`	`repositorySiteName()`
`void`	`resetSlotConfigurations()` Reset the slot to its original configurations.
`rx.Completable`	`resetSlotConfigurationsAsync()` Reset the slot to its original configurations.
`void`	`restart()` Restarts the web app or deployment slot.
`rx.Completable`	`restartAsync()` Restarts the web app or deployment slot.
`boolean`	`scmSiteAlsoStopped()`
`void`	`start()` Starts the web app or deployment slot.
`rx.Completable`	`startAsync()` Starts the web app or deployment slot.
`String`	`state()`
`void`	`stop()` Stops the web app or deployment slot.
`rx.Completable`	`stopAsync()` Stops the web app or deployment slot.
`void`	`swap(String slotName)` Swaps the app running in the current web app / slot with the app running in the specified slot.
`rx.Completable`	`swapAsync(String slotName)` Swaps the app running in the current web app / slot with the app running in the specified slot.
`String`	`targetSwapSlot()`
`Set<String>`	`trafficManagerHostNames()`
`UsageState`	`usageState()`
`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.
`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.
`boolean`	`webSocketsEnabled()`

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource
region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable
key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId
id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName
name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager
manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner
inner

- Method Detail
  - 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
  - isPremiumApp
```
boolean isPremiumApp()
```
    Returns:
    
    whether web app is deployed as a premium 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
  - microService
```
String microService()
```
    Returns:
    
    the micro-service name
  - gatewaySiteName
```
String gatewaySiteName()
```
    Returns:
    
    name of gateway app associated with web app
  - 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
  - appSettings
```
Map<String,AppSetting> appSettings()
```
    Returns:
    
    the app settings defined on the web app
  - connectionStrings
```
Map<String,ConnectionString> connectionStrings()
```
    Returns:
    
    the connection strings 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.
  - 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
  - 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

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Interface WebAppBase

Nested Class Summary

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Method Summary

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

Method Detail

state

hostNames

repositorySiteName

usageState

enabled

enabledHostNames

availabilityState

hostNameSslStates

appServicePlanId

lastModifiedTime

trafficManagerHostNames

isPremiumApp

scmSiteAlsoStopped

targetSwapSlot

microService

gatewaySiteName

clientAffinityEnabled

clientCertEnabled

hostNamesDisabled

outboundIPAddresses

containerSize

cloningInfo

isDefaultContainer

defaultHostName

defaultDocuments

netFrameworkVersion

phpVersion

pythonVersion

nodeVersion

remoteDebuggingEnabled

remoteDebuggingVersion

webSocketsEnabled

alwaysOn

javaVersion

javaContainer

javaContainerVersion

managedPipelineMode

autoSwapSlotName

appSettings

connectionStrings

operatingSystem

platformArchitecture

linuxFxVersion

getHostNameBindings

getHostNameBindingsAsync

getPublishingProfile

getPublishingProfileAsync

getSourceControl

getSourceControlAsync

deploy

verifyDomainOwnership

verifyDomainOwnershipAsync

start

startAsync

stop

stopAsync

restart

restartAsync

swap

swapAsync

applySlotConfigurations

applySlotConfigurationsAsync

resetSlotConfigurations

resetSlotConfigurationsAsync