WebSiteBase Interface

Package:

com.azure.resourcemanager.appservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.46.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() Gets the resource ID of the app service plan.
abstract SiteAvailabilityState	availabilityState() Gets management information availability state for the web app.
abstract boolean	clientAffinityEnabled() Check whether the client affinity is enabled when load balancing http request for multiple instances of the web app.
abstract boolean	clientCertEnabled() Check whether the client certificate is enabled for the web app.
abstract Set<String>	clientCertExclusionPaths() Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.
abstract CloningInfo	cloningInfo() Gets information about whether the web app is cloned from another.
abstract int	containerSize() Gets size of a function container.
abstract int	dailyMemoryTimeQuota() Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
abstract String	defaultHostname() Gets default hostname of the web app.
abstract boolean	enabled() Check whether the site is enabled.
abstract Set<String>	enabledHostNames() Gets host names for the web app that are enabled.
abstract HostingEnvironmentProfile	hostingEnvironmentProfile() Get the hostingEnvironmentProfile property: App Service Environment to use for the app.
abstract Map<String,HostnameSslState>	hostnameSslStates() Gets list of SSL states used to manage the SSL bindings for site's hostnames.
abstract Set<String>	hostnames() Gets hostnames associated with web app.
abstract boolean	hostnamesDisabled() Check whether the public hostnames are disabled for the web app.
abstract boolean	httpsOnly() Check whether the web app is configured to accept only HTTPS requests.
abstract boolean	hyperV() Get the hyperV property: Hyper-V sandbox.
abstract ManagedServiceIdentity	identity() Get the identity property: Managed service identity.
abstract boolean	isDefaultContainer() Check whether site is a default container.
abstract OffsetDateTime	lastModifiedTime() Gets last time web app was modified in UTC.
abstract int	maxNumberOfWorkers() Get the maxNumberOfWorkers property: Maximum number of workers.
abstract OperatingSystem	operatingSystem() Gets the operating system the web app is running on.
abstract Set<String>	outboundIPAddresses() Gets list of IP addresses that this web app uses for outbound connections.
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() Gets name of repository site.
abstract boolean	scmSiteAlsoStopped() Check whether to stop SCM (KUDU) site when the web app is stopped.
abstract SlotSwapStatus	slotSwapStatus() Get the slotSwapStatus property: Status of the last deployment slot swap operation.
abstract String	state() Gets state of the web app.
abstract OffsetDateTime	suspendedTill() Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.
abstract String	targetSwapSlot() Gets which slot this app will swap into.
abstract Set<String>	trafficManagerHostNames() Gets list of Azure Traffic manager host names associated with web app.
abstract UsageState	usageState() Gets state indicating whether web app has exceeded its quota usage.

Method Details

appServicePlanId

public abstract String appServicePlanId()

Gets the resource ID of the app service plan.

Returns:

The resource ID of the app service plan

availabilityState

public abstract SiteAvailabilityState availabilityState()

Gets management information availability state for the web app.

Returns:

management information availability state for the web app

clientAffinityEnabled

public abstract boolean clientAffinityEnabled()

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

Returns:

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

clientCertEnabled

public abstract boolean clientCertEnabled()

Check whether the client certificate is enabled for the web app.

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()

Gets information about whether the web app is cloned from another.

Returns:

information about whether the web app is cloned from another

containerSize

public abstract int containerSize()

Gets size of a function container.

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()

Gets default hostname of the web app.

Returns:

default hostname of the web app

enabled

public abstract boolean enabled()

Check whether the site is enabled.

Returns:

true if the site is enabled; otherwise, false

enabledHostNames

public abstract Set enabledHostNames()

Gets host names for the web app that are enabled.

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()

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

Returns:

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

hostnames

public abstract Set hostnames()

Gets hostnames associated with web app.

Returns:

hostnames associated with web app

hostnamesDisabled

public abstract boolean hostnamesDisabled()

Check whether the public hostnames are disabled for the web app.

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()

Check whether the web app is configured to accept only HTTPS requests.

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()

Check whether site is a default container.

Returns:

site is a default container

lastModifiedTime

public abstract OffsetDateTime lastModifiedTime()

Gets last time web app was modified in UTC.

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()

Gets the operating system the web app is running on.

Returns:

the operating system the web app is running on

outboundIPAddresses

public abstract Set outboundIPAddresses()

Gets list of IP addresses that this web app uses for outbound connections.

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()

Gets name of repository site.

Returns:

name of repository site

scmSiteAlsoStopped

public abstract boolean scmSiteAlsoStopped()

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

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()

Gets state of the web app.

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()

Gets which slot this app will swap into.

Returns:

which slot this app will swap into

trafficManagerHostNames

public abstract Set trafficManagerHostNames()

Gets list of Azure Traffic manager host names associated with web app.

Returns:

list of Azure Traffic manager host names associated with web app

usageState

public abstract UsageState usageState()

Gets state indicating whether web app has exceeded its quota usage.

Returns:

state indicating whether web app has exceeded its quota usage