Interface WebSiteBase
-
- All Superinterfaces:
HasId,HasInnerModel<SiteInner>,HasName,HasResourceGroup,Indexable,Resource
- All Known Subinterfaces:
DeploymentSlot,DeploymentSlotBase<FluentT>,FunctionApp,FunctionAppBasic,FunctionDeploymentSlot,FunctionDeploymentSlotBasic,WebApp,WebAppBase,WebAppBasic,WebDeploymentSlotBasic
public interface WebSiteBase extends Resource, HasResourceGroup, HasInnerModel<SiteInner>
An immutable client-side representation of an Azure Web App or Function App.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
Resource.DefinitionWithRegion<T extends Object>, Resource.DefinitionWithTags<T extends Object>, Resource.UpdateWithTags<T extends Object>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringappServicePlanId()SiteAvailabilityStateavailabilityState()booleanclientAffinityEnabled()booleanclientCertEnabled()Set<String>clientCertExclusionPaths()Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.CloningInfocloningInfo()intcontainerSize()intdailyMemoryTimeQuota()Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).StringdefaultHostname()booleanenabled()Set<String>enabledHostNames()HostingEnvironmentProfilehostingEnvironmentProfile()Get the hostingEnvironmentProfile property: App Service Environment to use for the app.Set<String>hostnames()booleanhostnamesDisabled()Map<String,HostnameSslState>hostnameSslStates()booleanhttpsOnly()booleanhyperV()Get the hyperV property: Hyper-V sandbox.ManagedServiceIdentityidentity()Get the identity property: Managed service identity.booleanisDefaultContainer()OffsetDateTimelastModifiedTime()intmaxNumberOfWorkers()Get the maxNumberOfWorkers property: Maximum number of workers.OperatingSystemoperatingSystem()Set<String>outboundIPAddresses()Set<String>possibleOutboundIpAddresses()Get the possibleOutboundIpAddresses property: List of IP addresses that the app uses for outbound connections (e.g.RedundancyModeredundancyMode()Get the redundancyMode property: Site redundancy mode.StringrepositorySiteName()booleanscmSiteAlsoStopped()SlotSwapStatusslotSwapStatus()Get the slotSwapStatus property: Status of the last deployment slot swap operation.Stringstate()OffsetDateTimesuspendedTill()Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.StringtargetSwapSlot()Set<String>trafficManagerHostNames()UsageStateusageState()-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel
innerModel
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName
name
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupName
-
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
region, regionName, tags, type
-
-
-
-
Method Detail
-
state
String state()
- Returns:
- state of the 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
-
lastModifiedTime
OffsetDateTime 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
-
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
-
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
-
httpsOnly
boolean httpsOnly()
- Returns:
- true if the web app is configured to accept only HTTPS requests. HTTP requests will be redirected.
-
appServicePlanId
String appServicePlanId()
- Returns:
- The resource ID of the app service plan
-
identity
ManagedServiceIdentity identity()
Get the identity property: Managed service identity.- Returns:
- the identity value.
-
hyperV
boolean hyperV()
Get the hyperV property: Hyper-V sandbox.- Returns:
- the hyperV value.
-
hostingEnvironmentProfile
HostingEnvironmentProfile hostingEnvironmentProfile()
Get the hostingEnvironmentProfile property: App Service Environment to use for the app.- Returns:
- the hostingEnvironmentProfile value.
-
clientCertExclusionPaths
Set<String> clientCertExclusionPaths()
Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.- Returns:
- the clientCertExclusionPaths value.
-
possibleOutboundIpAddresses
Set<String> 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.
-
dailyMemoryTimeQuota
int dailyMemoryTimeQuota()
Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).- Returns:
- the dailyMemoryTimeQuota value.
-
suspendedTill
OffsetDateTime suspendedTill()
Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.- Returns:
- the suspendedTill value.
-
maxNumberOfWorkers
int maxNumberOfWorkers()
Get the maxNumberOfWorkers property: Maximum number of workers. This only applies to Functions container.- Returns:
- the maxNumberOfWorkers value.
-
slotSwapStatus
SlotSwapStatus slotSwapStatus()
Get the slotSwapStatus property: Status of the last deployment slot swap operation.- Returns:
- the slotSwapStatus value.
-
redundancyMode
RedundancyMode redundancyMode()
Get the redundancyMode property: Site redundancy mode.- Returns:
- the redundancyMode value.
-
operatingSystem
OperatingSystem operatingSystem()
- Returns:
- the operating system the web app is running on
-
-