Interface WebSiteBase

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<SiteInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
All Known Subinterfaces:
DeploymentSlot, DeploymentSlotBase<FluentT>, FunctionApp, FunctionAppBasic, FunctionDeploymentSlot, FunctionDeploymentSlotBasic, WebApp, WebAppBase, WebAppBasic, WebDeploymentSlotBasic
public interface WebSiteBase extends com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.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

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

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

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

    id

    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.model.Indexable

    key

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

    region, regionName, tags, type

  • Method Details

    • state

      String state()
      Gets state of the web app.
      Returns:
      state of the web app

    • hostnames

      Set<String> hostnames()
      Gets hostnames associated with web app.
      Returns:
      hostnames associated with web app

    • repositorySiteName

      String repositorySiteName()
      Gets name of repository site.
      Returns:
      name of repository site

    • usageState

      UsageState usageState()
      Gets state indicating whether web app has exceeded its quota usage.
      Returns:
      state indicating whether web app has exceeded its quota usage

    • enabled

      boolean enabled()
      Check whether the site is enabled.
      Returns:
      true if the site is enabled; otherwise, false

    • enabledHostNames

      Set<String> enabledHostNames()
      Gets host names for the web app that are enabled.
      Returns:
      host names for the web app that are enabled

    • availabilityState

      SiteAvailabilityState availabilityState()
      Gets management information availability state for the web app.
      Returns:
      management information availability state for the web app

    • hostnameSslStates

      Map<String, HostnameSslState> 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

    • lastModifiedTime

      OffsetDateTime lastModifiedTime()
      Gets last time web app was modified in UTC.
      Returns:
      Last time web app was modified in UTC

    • trafficManagerHostNames

      Set<String> 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

    • scmSiteAlsoStopped

      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.

    • targetSwapSlot

      String targetSwapSlot()
      Gets which slot this app will swap into.
      Returns:
      which slot this app will swap into

    • clientAffinityEnabled

      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

      boolean clientCertEnabled()
      Check whether the client certificate is enabled for the web app.
      Returns:
      if the client certificate is enabled for the web app

    • hostnamesDisabled

      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.

    • outboundIPAddresses

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

    • containerSize

      int containerSize()
      Gets size of a function container.
      Returns:
      size of a function container

    • cloningInfo

      CloningInfo cloningInfo()
      Gets information about whether the web app is cloned from another.
      Returns:
      information about whether the web app is cloned from another

    • isDefaultContainer

      boolean isDefaultContainer()
      Check whether site is a default container.
      Returns:
      site is a default container

    • defaultHostname

      String defaultHostname()
      Gets default hostname of the web app.
      Returns:
      default hostname of the web app

    • httpsOnly

      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.

    • appServicePlanId

      String appServicePlanId()
      Gets the resource ID of the app service plan.
      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()
      Gets the operating system the web app is running on.
      Returns:
      the operating system the web app is running on