WebSiteBase Interface

Package:

com.azure.resourcemanager.appservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.38.0

Implements

HasResourceGroup Resource HasInnerModel<SiteInner>

public interface WebSiteBase
extends Resource, HasResourceGroup, HasInnerModel<SiteInner>

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

Method Summary

Modifier and Type	Method and Description
abstract String	appServicePlanId()
abstract SiteAvailabilityState	availabilityState()
abstract boolean	clientAffinityEnabled()
abstract boolean	clientCertEnabled()
abstract Set<String>	clientCertExclusionPaths() Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.
abstract CloningInfo	cloningInfo()
abstract int	containerSize()
abstract int	dailyMemoryTimeQuota() Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
abstract String	defaultHostname()
abstract boolean	enabled()
abstract Set<String>	enabledHostNames()
abstract HostingEnvironmentProfile	hostingEnvironmentProfile() Get the hostingEnvironmentProfile property: App Service Environment to use for the app.
abstract Map<String,HostnameSslState>	hostnameSslStates()
abstract Set<String>	hostnames()
abstract boolean	hostnamesDisabled()
abstract boolean	httpsOnly()
abstract boolean	hyperV() Get the hyperV property: Hyper-V sandbox.
abstract ManagedServiceIdentity	identity() Get the identity property: Managed service identity.
abstract boolean	isDefaultContainer()
abstract OffsetDateTime	lastModifiedTime()
abstract int	maxNumberOfWorkers() Get the maxNumberOfWorkers property: Maximum number of workers.
abstract OperatingSystem	operatingSystem()
abstract Set<String>	outboundIPAddresses()
abstract Set<String>	possibleOutboundIpAddresses() Get the possibleOutboundIpAddresses property: List of IP addresses that the app uses for outbound connections (e.g.
abstract RedundancyMode	redundancyMode() Get the redundancyMode property: Site redundancy mode.
abstract String	repositorySiteName()
abstract boolean	scmSiteAlsoStopped()
abstract SlotSwapStatus	slotSwapStatus() Get the slotSwapStatus property: Status of the last deployment slot swap operation.
abstract String	state()
abstract OffsetDateTime	suspendedTill() Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.
abstract String	targetSwapSlot()
abstract Set<String>	trafficManagerHostNames()
abstract UsageState	usageState()

Method Details

appServicePlanId

public abstract String appServicePlanId()

Returns:

The resource ID of the app service plan

availabilityState

public abstract SiteAvailabilityState availabilityState()

Returns:

management information availability state for the web app

clientAffinityEnabled

public abstract boolean clientAffinityEnabled()

Returns:

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

clientCertEnabled

public abstract boolean clientCertEnabled()

Returns:

if the client certificate is enabled for the web app

clientCertExclusionPaths

public abstract Set clientCertExclusionPaths()

Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.

Returns:

the clientCertExclusionPaths value.

cloningInfo

public abstract CloningInfo cloningInfo()

Returns:

information about whether the web app is cloned from another

containerSize

public abstract int containerSize()

Returns:

size of a function container

dailyMemoryTimeQuota

public abstract int dailyMemoryTimeQuota()

Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

Returns:

the dailyMemoryTimeQuota value.

defaultHostname

public abstract String defaultHostname()

Returns:

default hostname of the web app

enabled

public abstract boolean enabled()

Returns:

true if the site is enabled; otherwise, false

enabledHostNames

public abstract Set enabledHostNames()

Returns:

host names for the web app that are enabled

hostingEnvironmentProfile

public abstract HostingEnvironmentProfile hostingEnvironmentProfile()

Get the hostingEnvironmentProfile property: App Service Environment to use for the app.

Returns:

the hostingEnvironmentProfile value.

hostnameSslStates

public abstract Map hostnameSslStates()

Returns:

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

hostnames

public abstract Set hostnames()

Returns:

hostnames associated with web app

hostnamesDisabled

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

httpsOnly

public abstract boolean httpsOnly()

Returns:

true if the web app is configured to accept only HTTPS requests. HTTP requests will be redirected.

hyperV

public abstract boolean hyperV()

Get the hyperV property: Hyper-V sandbox.

Returns:

the hyperV value.

identity

public abstract ManagedServiceIdentity identity()

Get the identity property: Managed service identity.

Returns:

the identity value.

isDefaultContainer

public abstract boolean isDefaultContainer()

Returns:

site is a default container

lastModifiedTime

public abstract OffsetDateTime lastModifiedTime()

Returns:

Last time web app was modified in UTC

maxNumberOfWorkers

public abstract int maxNumberOfWorkers()

Get the maxNumberOfWorkers property: Maximum number of workers. This only applies to Functions container.

Returns:

the maxNumberOfWorkers value.

operatingSystem

public abstract OperatingSystem operatingSystem()

Returns:

the operating system the web app is running on

outboundIPAddresses

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

possibleOutboundIpAddresses

public abstract Set possibleOutboundIpAddresses()

Get the possibleOutboundIpAddresses property: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

Returns:

the possibleOutboundIpAddresses value.

redundancyMode

public abstract RedundancyMode redundancyMode()

Get the redundancyMode property: Site redundancy mode.

Returns:

the redundancyMode value.

repositorySiteName

public abstract String repositorySiteName()

Returns:

name of repository site

scmSiteAlsoStopped

public abstract boolean scmSiteAlsoStopped()

Returns:

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

slotSwapStatus

public abstract SlotSwapStatus slotSwapStatus()

Get the slotSwapStatus property: Status of the last deployment slot swap operation.

Returns:

the slotSwapStatus value.

state

public abstract String state()

Returns:

state of the web app

suspendedTill

public abstract OffsetDateTime suspendedTill()

Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.

Returns:

the suspendedTill value.

targetSwapSlot

public abstract String targetSwapSlot()

Returns:

which slot this app will swap into

trafficManagerHostNames

public abstract Set trafficManagerHostNames()

Returns:

list of Azure Traffic manager host names associated with web app

usageState

public abstract UsageState usageState()

Returns:

state indicating whether web app has exceeded its quota usage