Class SitePatchResourceInner

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.appservice.models.ProxyOnlyResource
com.azure.resourcemanager.appservice.fluent.models.SitePatchResourceInner
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class SitePatchResourceInner extends ProxyOnlyResource
ARM resource for a site.

  • Constructor Details

    • SitePatchResourceInner

      public SitePatchResourceInner()
      Creates an instance of SitePatchResourceInner class.

  • Method Details

    • identity

      public ManagedServiceIdentity identity()
      Get the identity property: Managed service identity.
      Returns:
      the identity value.

    • withIdentity

      public SitePatchResourceInner withIdentity(ManagedServiceIdentity identity)
      Set the identity property: Managed service identity.
      Parameters:
      identity - the identity value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class ProxyOnlyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class ProxyOnlyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class ProxyOnlyResource
      Returns:
      the id value.

    • withKind

      public SitePatchResourceInner withKind(String kind)
      Set the kind property: Kind of resource.
      Overrides:
      withKind in class ProxyOnlyResource
      Parameters:
      kind - the kind value to set.
      Returns:
      the ProxyOnlyResource object itself.

    • state

      public String state()
      Get the state property: Current state of the app.
      Returns:
      the state value.

    • hostNames

      public List<String> hostNames()
      Get the hostNames property: Hostnames associated with the app.
      Returns:
      the hostNames value.

    • repositorySiteName

      public String repositorySiteName()
      Get the repositorySiteName property: Name of the repository site.
      Returns:
      the repositorySiteName value.

    • usageState

      public UsageState usageState()
      Get the usageState property: State indicating whether the app has exceeded its quota usage. Read-only.
      Returns:
      the usageState value.

    • enabled

      public Boolean enabled()
      Get the enabled property: <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 SitePatchResourceInner withEnabled(Boolean enabled)
      Set the enabled property: <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 SitePatchResourceInner object itself.

    • enabledHostNames

      public List<String> enabledHostNames()
      Get the enabledHostNames property: 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 the availabilityState property: Management information availability state for the app.
      Returns:
      the availabilityState value.

    • hostnameSslStates

      public List<HostnameSslState> hostnameSslStates()
      Get the hostnameSslStates property: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
      Returns:
      the hostnameSslStates value.

    • withHostnameSslStates

      public SitePatchResourceInner withHostnameSslStates(List<HostnameSslState> hostnameSslStates)
      Set the hostnameSslStates property: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
      Parameters:
      hostnameSslStates - the hostnameSslStates value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • serverFarmId

      public String serverFarmId()
      Get the serverFarmId property: 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 SitePatchResourceInner withServerFarmId(String serverFarmId)
      Set the serverFarmId property: 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 SitePatchResourceInner object itself.

    • reserved

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

    • withReserved

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

    • isXenon

      public Boolean isXenon()
      Get the isXenon property: Obsolete: Hyper-V sandbox.
      Returns:
      the isXenon value.

    • withIsXenon

      public SitePatchResourceInner withIsXenon(Boolean isXenon)
      Set the isXenon property: Obsolete: Hyper-V sandbox.
      Parameters:
      isXenon - the isXenon value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • hyperV

      public Boolean hyperV()
      Get the hyperV property: Hyper-V sandbox.
      Returns:
      the hyperV value.

    • withHyperV

      public SitePatchResourceInner withHyperV(Boolean hyperV)
      Set the hyperV property: Hyper-V sandbox.
      Parameters:
      hyperV - the hyperV value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • lastModifiedTimeUtc

      public OffsetDateTime lastModifiedTimeUtc()
      Get the lastModifiedTimeUtc property: Last time the app was modified, in UTC. Read-only.
      Returns:
      the lastModifiedTimeUtc value.

    • dnsConfiguration

      public SiteDnsConfig dnsConfiguration()
      Get the dnsConfiguration property: Property to configure various DNS related settings for a site.
      Returns:
      the dnsConfiguration value.

    • withDnsConfiguration

      public SitePatchResourceInner withDnsConfiguration(SiteDnsConfig dnsConfiguration)
      Set the dnsConfiguration property: Property to configure various DNS related settings for a site.
      Parameters:
      dnsConfiguration - the dnsConfiguration value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • siteConfig

      public SiteConfigInner siteConfig()
      Get the siteConfig property: Configuration of the app.
      Returns:
      the siteConfig value.

    • withSiteConfig

      public SitePatchResourceInner withSiteConfig(SiteConfigInner siteConfig)
      Set the siteConfig property: Configuration of the app.
      Parameters:
      siteConfig - the siteConfig value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • trafficManagerHostNames

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

    • scmSiteAlsoStopped

      public Boolean scmSiteAlsoStopped()
      Get the scmSiteAlsoStopped property: <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 SitePatchResourceInner withScmSiteAlsoStopped(Boolean scmSiteAlsoStopped)
      Set the scmSiteAlsoStopped property: <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 SitePatchResourceInner object itself.

    • targetSwapSlot

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

    • hostingEnvironmentProfile

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

    • withHostingEnvironmentProfile

      public SitePatchResourceInner withHostingEnvironmentProfile(HostingEnvironmentProfile hostingEnvironmentProfile)
      Set the hostingEnvironmentProfile property: App Service Environment to use for the app.
      Parameters:
      hostingEnvironmentProfile - the hostingEnvironmentProfile value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • clientAffinityEnabled

      public Boolean clientAffinityEnabled()
      Get the clientAffinityEnabled property: <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 SitePatchResourceInner withClientAffinityEnabled(Boolean clientAffinityEnabled)
      Set the clientAffinityEnabled property: <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 SitePatchResourceInner object itself.

    • clientAffinityProxyEnabled

      public Boolean clientAffinityProxyEnabled()
      Get the clientAffinityProxyEnabled property: <code>true</code> to override client affinity cookie domain with X-Forwarded-Host request header. <code>false</code> to use default domain. Default is <code>false</code>.
      Returns:
      the clientAffinityProxyEnabled value.

    • withClientAffinityProxyEnabled

      public SitePatchResourceInner withClientAffinityProxyEnabled(Boolean clientAffinityProxyEnabled)
      Set the clientAffinityProxyEnabled property: <code>true</code> to override client affinity cookie domain with X-Forwarded-Host request header. <code>false</code> to use default domain. Default is <code>false</code>.
      Parameters:
      clientAffinityProxyEnabled - the clientAffinityProxyEnabled value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • clientCertEnabled

      public Boolean clientCertEnabled()
      Get the clientCertEnabled property: <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 SitePatchResourceInner withClientCertEnabled(Boolean clientCertEnabled)
      Set the clientCertEnabled property: <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 SitePatchResourceInner object itself.

    • clientCertMode

      public ClientCertMode clientCertMode()
      Get the clientCertMode property: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.
      Returns:
      the clientCertMode value.

    • withClientCertMode

      public SitePatchResourceInner withClientCertMode(ClientCertMode clientCertMode)
      Set the clientCertMode property: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.
      Parameters:
      clientCertMode - the clientCertMode value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • clientCertExclusionPaths

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

    • withClientCertExclusionPaths

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

    • hostNamesDisabled

      public Boolean hostNamesDisabled()
      Get the hostNamesDisabled property: <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 SitePatchResourceInner withHostNamesDisabled(Boolean hostNamesDisabled)
      Set the hostNamesDisabled property: <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 SitePatchResourceInner object itself.

    • customDomainVerificationId

      public String customDomainVerificationId()
      Get the customDomainVerificationId property: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
      Returns:
      the customDomainVerificationId value.

    • withCustomDomainVerificationId

      public SitePatchResourceInner withCustomDomainVerificationId(String customDomainVerificationId)
      Set the customDomainVerificationId property: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
      Parameters:
      customDomainVerificationId - the customDomainVerificationId value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • outboundIpAddresses

      public String outboundIpAddresses()
      Get the outboundIpAddresses property: 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 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.

    • containerSize

      public Integer containerSize()
      Get the containerSize property: Size of the function container.
      Returns:
      the containerSize value.

    • withContainerSize

      public SitePatchResourceInner withContainerSize(Integer containerSize)
      Set the containerSize property: Size of the function container.
      Parameters:
      containerSize - the containerSize value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • dailyMemoryTimeQuota

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

    • withDailyMemoryTimeQuota

      public SitePatchResourceInner withDailyMemoryTimeQuota(Integer dailyMemoryTimeQuota)
      Set the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
      Parameters:
      dailyMemoryTimeQuota - the dailyMemoryTimeQuota value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • suspendedTill

      public OffsetDateTime suspendedTill()
      Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.
      Returns:
      the suspendedTill value.

    • maxNumberOfWorkers

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

    • cloningInfo

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

    • withCloningInfo

      public SitePatchResourceInner withCloningInfo(CloningInfo cloningInfo)
      Set the cloningInfo property: If specified during app creation, the app is cloned from a source app.
      Parameters:
      cloningInfo - the cloningInfo value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • resourceGroup

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

    • isDefaultContainer

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

    • defaultHostname

      public String defaultHostname()
      Get the defaultHostname property: Default hostname of the app. Read-only.
      Returns:
      the defaultHostname value.

    • slotSwapStatus

      public SlotSwapStatus slotSwapStatus()
      Get the slotSwapStatus property: Status of the last deployment slot swap operation.
      Returns:
      the slotSwapStatus value.

    • httpsOnly

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

    • withHttpsOnly

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

    • redundancyMode

      public RedundancyMode redundancyMode()
      Get the redundancyMode property: Site redundancy mode.
      Returns:
      the redundancyMode value.

    • withRedundancyMode

      public SitePatchResourceInner withRedundancyMode(RedundancyMode redundancyMode)
      Set the redundancyMode property: Site redundancy mode.
      Parameters:
      redundancyMode - the redundancyMode value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • inProgressOperationId

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

    • publicNetworkAccess

      public String publicNetworkAccess()
      Get the publicNetworkAccess property: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.
      Returns:
      the publicNetworkAccess value.

    • withPublicNetworkAccess

      public SitePatchResourceInner withPublicNetworkAccess(String publicNetworkAccess)
      Set the publicNetworkAccess property: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • storageAccountRequired

      public Boolean storageAccountRequired()
      Get the storageAccountRequired property: Checks if Customer provided storage account is required.
      Returns:
      the storageAccountRequired value.

    • withStorageAccountRequired

      public SitePatchResourceInner withStorageAccountRequired(Boolean storageAccountRequired)
      Set the storageAccountRequired property: Checks if Customer provided storage account is required.
      Parameters:
      storageAccountRequired - the storageAccountRequired value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • keyVaultReferenceIdentity

      public String keyVaultReferenceIdentity()
      Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.
      Returns:
      the keyVaultReferenceIdentity value.

    • withKeyVaultReferenceIdentity

      public SitePatchResourceInner withKeyVaultReferenceIdentity(String keyVaultReferenceIdentity)
      Set the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.
      Parameters:
      keyVaultReferenceIdentity - the keyVaultReferenceIdentity value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • virtualNetworkSubnetId

      public String virtualNetworkSubnetId()
      Get the virtualNetworkSubnetId property: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.
      Returns:
      the virtualNetworkSubnetId value.

    • withVirtualNetworkSubnetId

      public SitePatchResourceInner withVirtualNetworkSubnetId(String virtualNetworkSubnetId)
      Set the virtualNetworkSubnetId property: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.
      Parameters:
      virtualNetworkSubnetId - the virtualNetworkSubnetId value to set.
      Returns:
      the SitePatchResourceInner object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ProxyOnlyResource
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class ProxyOnlyResource
      Throws:
      IOException

    • fromJson

      public static SitePatchResourceInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of SitePatchResourceInner from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of SitePatchResourceInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the SitePatchResourceInner.