Class SitePatchResource

    • Constructor Detail

      • SitePatchResource

        public SitePatchResource()
    • Method Detail

      • state

        public String state()
        Get current state of the app.
        Returns:
        the state value
      • hostNames

        public List<String> hostNames()
        Get hostnames associated with the app.
        Returns:
        the hostNames value
      • repositorySiteName

        public String repositorySiteName()
        Get name of the repository site.
        Returns:
        the repositorySiteName value
      • usageState

        public UsageState usageState()
        Get state indicating whether the app has exceeded its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded'.
        Returns:
        the usageState value
      • enabled

        public Boolean enabled()
        Get <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).
        Returns:
        the enabled value
      • withEnabled

        public SitePatchResource withEnabled​(Boolean enabled)
        Set <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).
        Parameters:
        enabled - the enabled value to set
        Returns:
        the SitePatchResource object itself.
      • enabledHostNames

        public List<String> enabledHostNames()
        Get enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.
        Returns:
        the enabledHostNames value
      • availabilityState

        public SiteAvailabilityState availabilityState()
        Get management information availability state for the app. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode'.
        Returns:
        the availabilityState value
      • hostNameSslStates

        public List<HostNameSslState> hostNameSslStates()
        Get hostname SSL states are used to manage the SSL bindings for app's hostnames.
        Returns:
        the hostNameSslStates value
      • withHostNameSslStates

        public SitePatchResource withHostNameSslStates​(List<HostNameSslState> hostNameSslStates)
        Set hostname SSL states are used to manage the SSL bindings for app's hostnames.
        Parameters:
        hostNameSslStates - the hostNameSslStates value to set
        Returns:
        the SitePatchResource object itself.
      • serverFarmId

        public String serverFarmId()
        Get resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
        Returns:
        the serverFarmId value
      • withServerFarmId

        public SitePatchResource withServerFarmId​(String serverFarmId)
        Set resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
        Parameters:
        serverFarmId - the serverFarmId value to set
        Returns:
        the SitePatchResource object itself.
      • reserved

        public Boolean reserved()
        Get <code>true</code> if reserved; otherwise, <code>false</code>.
        Returns:
        the reserved value
      • withReserved

        public SitePatchResource withReserved​(Boolean reserved)
        Set <code>true</code> if reserved; otherwise, <code>false</code>.
        Parameters:
        reserved - the reserved value to set
        Returns:
        the SitePatchResource object itself.
      • isXenon

        public Boolean isXenon()
        Get obsolete: Hyper-V sandbox.
        Returns:
        the isXenon value
      • withIsXenon

        public SitePatchResource withIsXenon​(Boolean isXenon)
        Set obsolete: Hyper-V sandbox.
        Parameters:
        isXenon - the isXenon value to set
        Returns:
        the SitePatchResource object itself.
      • hyperV

        public Boolean hyperV()
        Get hyper-V sandbox.
        Returns:
        the hyperV value
      • withHyperV

        public SitePatchResource withHyperV​(Boolean hyperV)
        Set hyper-V sandbox.
        Parameters:
        hyperV - the hyperV value to set
        Returns:
        the SitePatchResource object itself.
      • lastModifiedTimeUtc

        public org.joda.time.DateTime lastModifiedTimeUtc()
        Get last time the app was modified, in UTC. Read-only.
        Returns:
        the lastModifiedTimeUtc value
      • siteConfig

        public SiteConfig siteConfig()
        Get configuration of the app.
        Returns:
        the siteConfig value
      • withSiteConfig

        public SitePatchResource withSiteConfig​(SiteConfig siteConfig)
        Set configuration of the app.
        Parameters:
        siteConfig - the siteConfig value to set
        Returns:
        the SitePatchResource object itself.
      • trafficManagerHostNames

        public List<String> trafficManagerHostNames()
        Get azure Traffic Manager hostnames associated with the app. Read-only.
        Returns:
        the trafficManagerHostNames value
      • scmSiteAlsoStopped

        public Boolean scmSiteAlsoStopped()
        Get <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.
        Returns:
        the scmSiteAlsoStopped value
      • withScmSiteAlsoStopped

        public SitePatchResource withScmSiteAlsoStopped​(Boolean scmSiteAlsoStopped)
        Set <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.
        Parameters:
        scmSiteAlsoStopped - the scmSiteAlsoStopped value to set
        Returns:
        the SitePatchResource object itself.
      • targetSwapSlot

        public String targetSwapSlot()
        Get specifies which deployment slot this app will swap into. Read-only.
        Returns:
        the targetSwapSlot value
      • hostingEnvironmentProfile

        public HostingEnvironmentProfile hostingEnvironmentProfile()
        Get app Service Environment to use for the app.
        Returns:
        the hostingEnvironmentProfile value
      • withHostingEnvironmentProfile

        public SitePatchResource withHostingEnvironmentProfile​(HostingEnvironmentProfile hostingEnvironmentProfile)
        Set app Service Environment to use for the app.
        Parameters:
        hostingEnvironmentProfile - the hostingEnvironmentProfile value to set
        Returns:
        the SitePatchResource object itself.
      • clientAffinityEnabled

        public Boolean clientAffinityEnabled()
        Get <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.
        Returns:
        the clientAffinityEnabled value
      • withClientAffinityEnabled

        public SitePatchResource withClientAffinityEnabled​(Boolean clientAffinityEnabled)
        Set <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.
        Parameters:
        clientAffinityEnabled - the clientAffinityEnabled value to set
        Returns:
        the SitePatchResource object itself.
      • clientCertEnabled

        public Boolean clientCertEnabled()
        Get <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.
        Returns:
        the clientCertEnabled value
      • withClientCertEnabled

        public SitePatchResource withClientCertEnabled​(Boolean clientCertEnabled)
        Set <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.
        Parameters:
        clientCertEnabled - the clientCertEnabled value to set
        Returns:
        the SitePatchResource object itself.
      • clientCertExclusionPaths

        public String clientCertExclusionPaths()
        Get client certificate authentication comma-separated exclusion paths.
        Returns:
        the clientCertExclusionPaths value
      • withClientCertExclusionPaths

        public SitePatchResource withClientCertExclusionPaths​(String clientCertExclusionPaths)
        Set client certificate authentication comma-separated exclusion paths.
        Parameters:
        clientCertExclusionPaths - the clientCertExclusionPaths value to set
        Returns:
        the SitePatchResource object itself.
      • hostNamesDisabled

        public Boolean hostNamesDisabled()
        Get <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.
        Returns:
        the hostNamesDisabled value
      • withHostNamesDisabled

        public SitePatchResource withHostNamesDisabled​(Boolean hostNamesDisabled)
        Set <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.
        Parameters:
        hostNamesDisabled - the hostNamesDisabled value to set
        Returns:
        the SitePatchResource object itself.
      • outboundIpAddresses

        public String outboundIpAddresses()
        Get list of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
        Returns:
        the outboundIpAddresses value
      • possibleOutboundIpAddresses

        public String possibleOutboundIpAddresses()
        Get list of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
        Returns:
        the possibleOutboundIpAddresses value
      • containerSize

        public Integer containerSize()
        Get size of the function container.
        Returns:
        the containerSize value
      • withContainerSize

        public SitePatchResource withContainerSize​(Integer containerSize)
        Set size of the function container.
        Parameters:
        containerSize - the containerSize value to set
        Returns:
        the SitePatchResource object itself.
      • dailyMemoryTimeQuota

        public Integer dailyMemoryTimeQuota()
        Get maximum allowed daily memory-time quota (applicable on dynamic apps only).
        Returns:
        the dailyMemoryTimeQuota value
      • withDailyMemoryTimeQuota

        public SitePatchResource withDailyMemoryTimeQuota​(Integer dailyMemoryTimeQuota)
        Set maximum allowed daily memory-time quota (applicable on dynamic apps only).
        Parameters:
        dailyMemoryTimeQuota - the dailyMemoryTimeQuota value to set
        Returns:
        the SitePatchResource object itself.
      • suspendedTill

        public org.joda.time.DateTime suspendedTill()
        Get app suspended till in case memory-time quota is exceeded.
        Returns:
        the suspendedTill value
      • maxNumberOfWorkers

        public Integer maxNumberOfWorkers()
        Get maximum number of workers. This only applies to Functions container.
        Returns:
        the maxNumberOfWorkers value
      • cloningInfo

        public CloningInfo cloningInfo()
        Get if specified during app creation, the app is cloned from a source app.
        Returns:
        the cloningInfo value
      • withCloningInfo

        public SitePatchResource withCloningInfo​(CloningInfo cloningInfo)
        Set if specified during app creation, the app is cloned from a source app.
        Parameters:
        cloningInfo - the cloningInfo value to set
        Returns:
        the SitePatchResource object itself.
      • resourceGroup

        public String resourceGroup()
        Get name of the resource group the app belongs to. Read-only.
        Returns:
        the resourceGroup value
      • isDefaultContainer

        public Boolean isDefaultContainer()
        Get <code>true</code> if the app is a default container; otherwise, <code>false</code>.
        Returns:
        the isDefaultContainer value
      • defaultHostName

        public String defaultHostName()
        Get default hostname of the app. Read-only.
        Returns:
        the defaultHostName value
      • slotSwapStatus

        public SlotSwapStatus slotSwapStatus()
        Get status of the last deployment slot swap operation.
        Returns:
        the slotSwapStatus value
      • httpsOnly

        public Boolean httpsOnly()
        Get httpsOnly: configures a web site to accept only https requests. Issues redirect for http requests.
        Returns:
        the httpsOnly value
      • withHttpsOnly

        public SitePatchResource withHttpsOnly​(Boolean httpsOnly)
        Set httpsOnly: configures a web site to accept only https requests. Issues redirect for http requests.
        Parameters:
        httpsOnly - the httpsOnly value to set
        Returns:
        the SitePatchResource object itself.
      • redundancyMode

        public RedundancyMode redundancyMode()
        Get site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant'.
        Returns:
        the redundancyMode value
      • withRedundancyMode

        public SitePatchResource withRedundancyMode​(RedundancyMode redundancyMode)
        Set site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant'.
        Parameters:
        redundancyMode - the redundancyMode value to set
        Returns:
        the SitePatchResource object itself.
      • inProgressOperationId

        public UUID inProgressOperationId()
        Get specifies an operation id if this site has a pending operation.
        Returns:
        the inProgressOperationId value
      • geoDistributions

        public List<GeoDistribution> geoDistributions()
        Get geoDistributions for this site.
        Returns:
        the geoDistributions value
      • withGeoDistributions

        public SitePatchResource withGeoDistributions​(List<GeoDistribution> geoDistributions)
        Set geoDistributions for this site.
        Parameters:
        geoDistributions - the geoDistributions value to set
        Returns:
        the SitePatchResource object itself.
      • withIdentity

        public SitePatchResource withIdentity​(ManagedServiceIdentity identity)
        Set the identity value.
        Parameters:
        identity - the identity value to set
        Returns:
        the SiteInner object itself.