你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

WebAppBase Interface

Package:

com.microsoft.azure.management.appservice

public interface WebAppBase extends HasName,GroupableResource<AppServiceManager, SiteInner>

An immutable client-side representation of an Azure Web App or deployment slot.

Method Summary

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. This is useful for "Swap with Preview".
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".
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()
Observable<Map<String, HostNameBinding>>	getHostNameBindingsAsync()
PublishingProfile	getPublishingProfile()
Observable<PublishingProfile>	getPublishingProfileAsync()
WebAppSourceControl	getSourceControl()
Observable<WebAppSourceControl>	getSourceControlAsync()
Set<String>	hostNames()
boolean	hostNamesDisabled()
Map<String, HostNameSslState>	hostNameSslStates()
boolean	isDefaultContainer()
boolean	isPremiumApp()
String	javaContainer()
String	javaContainerVersion()
JavaVersion	javaVersion()
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.
Completable	resetSlotConfigurationsAsync() Reset the slot to its original configurations.
void	restart() Restarts the web app or deployment slot.
Completable	restartAsync() Restarts the web app or deployment slot.
boolean	scmSiteAlsoStopped()
void	start() Starts the web app or deployment slot.
Completable	startAsync() Starts the web app or deployment slot.
String	state()
void	stop() Stops the web app or deployment slot.
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.
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.
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()

Inherited Members

HasId.id() HasInner<T>.inner() Indexable.key() HasManager<ManagerT>.manager() HasName.name() Resource.region() Resource.regionName() HasResourceGroup.resourceGroupName() Resource.tags() Resource.type()

Method Details

alwaysOn

public boolean alwaysOn()

Returns:

if the web app is always on

applySlotConfigurations

public 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

public 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

appServicePlanId

public String appServicePlanId()

Returns:

The resource ID of the app service plan

appSettings

public Map appSettings()

Returns:

the app settings defined on the web app

autoSwapSlotName

public String autoSwapSlotName()

Returns:

the auto swap slot name

availabilityState

public SiteAvailabilityState availabilityState()

Returns:

management information availability state for the web app

clientAffinityEnabled

public boolean clientAffinityEnabled()

Returns:

if the client affinity is enabled when load balancing http request for multiple instances of the web app

clientCertEnabled

public boolean clientCertEnabled()

Returns:

if the client certificate is enabled for the web app

cloningInfo

public CloningInfo cloningInfo()

Returns:

information about whether the web app is cloned from another

connectionStrings

public Map connectionStrings()

Returns:

the connection strings defined on the web app

containerSize

public int containerSize()

Returns:

size of a function container

defaultDocuments

public List defaultDocuments()

Returns:

the default documents

defaultHostName

public String defaultHostName()

Returns:

default hostname of the web app

deploy

public 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

enabled

public boolean enabled()

Returns:

true if the site is enabled; otherwise, false

enabledHostNames

public Set enabledHostNames()

Returns:

host names for the web app that are enabled

gatewaySiteName

public String gatewaySiteName()

Returns:

name of gateway app associated with web app

getHostNameBindings

public Map getHostNameBindings()

Returns:

the mapping from host names and the host name bindings

getHostNameBindingsAsync

public Observable<>> getHostNameBindingsAsync()

Returns:

the mapping from host names and the host name bindings

getPublishingProfile

public PublishingProfile getPublishingProfile()

Returns:

the URL and credentials for publishing through FTP or Git

getPublishingProfileAsync

public Observable getPublishingProfileAsync()

Returns:

the URL and credentials for publishing through FTP or Git

getSourceControl

public WebAppSourceControl getSourceControl()

Returns:

the source control information for the web app

getSourceControlAsync

public Observable getSourceControlAsync()

Returns:

the source control information for the web app

hostNames

public Set hostNames()

Returns:

hostnames associated with web app

hostNamesDisabled

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

hostNameSslStates

public Map hostNameSslStates()

Returns:

list of SSL states used to manage the SSL bindings for site's hostnames

isDefaultContainer

public boolean isDefaultContainer()

Returns:

site is a default container

isPremiumApp

public boolean isPremiumApp()

Returns:

whether web app is deployed as a premium app

javaContainer

public String javaContainer()

Returns:

Java container

javaContainerVersion

public String javaContainerVersion()

Returns:

Java container version

javaVersion

public JavaVersion javaVersion()

Returns:

Java version

lastModifiedTime

public DateTime lastModifiedTime()

Returns:

Last time web app was modified in UTC

linuxFxVersion

public String linuxFxVersion()

Returns:

the Linux app framework and version if this is a Linux web app.

managedPipelineMode

public ManagedPipelineMode managedPipelineMode()

Returns:

managed pipeline mode

microService

public String microService()

Returns:

the micro-service name

netFrameworkVersion

public NetFrameworkVersion netFrameworkVersion()

Returns:

the .NET Framework version

nodeVersion

public String nodeVersion()

Returns:

the version of Node.JS

operatingSystem

public OperatingSystem operatingSystem()

Returns:

the operating system the web app is running on

outboundIPAddresses

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

phpVersion

public PhpVersion phpVersion()

Returns:

the version of PHP

platformArchitecture

public PlatformArchitecture platformArchitecture()

Returns:

the architecture of the platform, either 32 bit (x86) or 64 bit (x64).

pythonVersion

public PythonVersion pythonVersion()

Returns:

the version of Python

remoteDebuggingEnabled

public boolean remoteDebuggingEnabled()

Returns:

if the remote eebugging is enabled

remoteDebuggingVersion

public RemoteVisualStudioVersion remoteDebuggingVersion()

Returns:

the remote debugging version

repositorySiteName

public String repositorySiteName()

Returns:

name of repository site

resetSlotConfigurations

public void resetSlotConfigurations()

Reset the slot to its original configurations.

resetSlotConfigurationsAsync

public Completable resetSlotConfigurationsAsync()

Reset the slot to its original configurations.

Returns:

a representation of the deferred computation of this call

restart

public void restart()

Restarts the web app or deployment slot.

restartAsync

public Completable restartAsync()

Restarts the web app or deployment slot.

Returns:

a representation of the deferred computation of this call

scmSiteAlsoStopped

public boolean scmSiteAlsoStopped()

Returns:

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

start

public void start()

Starts the web app or deployment slot.

startAsync

public Completable startAsync()

Starts the web app or deployment slot.

Returns:

a representation of the deferred computation of this call

state

public String state()

Returns:

state of the web app

stop

public void stop()

Stops the web app or deployment slot.

stopAsync

public Completable stopAsync()

Stops the web app or deployment slot.

Returns:

a representation of the deferred computation of this call

swap

public 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

public 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

targetSwapSlot

public String targetSwapSlot()

Returns:

which slot this app will swap into

trafficManagerHostNames

public Set trafficManagerHostNames()

Returns:

list of Azure Traffic manager host names associated with web app

usageState

public UsageState usageState()

Returns:

state indicating whether web app has exceeded its quota usage

verifyDomainOwnership

public 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

public 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

webSocketsEnabled

public boolean webSocketsEnabled()

Returns:

if web socket is enabled