Class SitePatchResourcePropertiesInner
java.lang.Object
com.azure.resourcemanager.appservice.fluent.models.SitePatchResourcePropertiesInner
- All Implemented Interfaces:
com.azure.json.JsonSerializable<SitePatchResourcePropertiesInner>
public final class SitePatchResourcePropertiesInner
extends Object
implements com.azure.json.JsonSerializable<SitePatchResourcePropertiesInner>
SitePatchResource resource specific properties.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of SitePatchResourcePropertiesInner class. -
Method Summary
Modifier and TypeMethodDescriptionGet the availabilityState property: Management information availability state for the app.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.Get the clientCertEnabled property: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>.Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.Get the clientCertMode property: This composes with ClientCertEnabled settingGet the cloningInfo property: If specified during app creation, the app is cloned from a source app.Get the containerSize property: Size of the function container.Get the customDomainVerificationId property: Unique identifier that verifies the custom domains assigned to the app.Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).Get the defaultHostname property: Default hostname of the app.Get the dnsConfiguration property: Property to configure various DNS related settings for a site.enabled()
Get the enabled property: <code>true</code> if the app is enabled; otherwise, <code>false</code>.Get the enabledHostNames property: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled.fromJson
(com.azure.json.JsonReader jsonReader) Reads an instance of SitePatchResourcePropertiesInner from the JsonReader.Get the hostingEnvironmentProfile property: App Service Environment to use for the app.Get the hostNames property: Hostnames associated with the app.Get the hostNamesDisabled property: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.Get the hostnameSslStates property: Hostname SSL states are used to manage the SSL bindings for app's hostnames.Get the httpsOnly property: HttpsOnly: configures a web site to accept only https requests.hyperV()
Get the hyperV property: Hyper-V sandbox.Get the inProgressOperationId property: Specifies an operation id if this site has a pending operation.Get the isDefaultContainer property: <code>true</code> if the app is a default container; otherwise, <code>false</code>.isXenon()
Get the isXenon property: Obsolete: Hyper-V sandbox.Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.Get the lastModifiedTimeUtc property: Last time the app was modified, in UTC.Get the maxNumberOfWorkers property: Maximum number of workers.Get the outboundIpAddresses property: List of IP addresses that the app uses for outbound connections (e.g.Get the possibleOutboundIpAddresses property: List of IP addresses that the app uses for outbound connections (e.g. database access).Get the redundancyMode property: Site redundancy mode.Get the repositorySiteName property: Name of the repository site.reserved()
Get the reserved property: <code>true</code> if reserved; otherwise, <code>false</code>.Get the resourceGroup property: Name of the resource group the app belongs to.Get the scmSiteAlsoStopped property: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>.Get the serverFarmId property: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".Get the siteConfig property: Configuration of the app.Get the slotSwapStatus property: Status of the last deployment slot swap operation.state()
Get the state property: Current state of the app.Get the storageAccountRequired property: Checks if Customer provided storage account is required.Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.Get the targetSwapSlot property: Specifies which deployment slot this app will swap into.com.azure.json.JsonWriter
toJson
(com.azure.json.JsonWriter jsonWriter) Get the trafficManagerHostNames property: Azure Traffic Manager hostnames associated with the app.Get the usageState property: State indicating whether the app has exceeded its quota usage.void
validate()
Validates the instance.Get the virtualNetworkSubnetId property: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.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.withClientCertEnabled
(Boolean clientCertEnabled) Set the clientCertEnabled property: <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>.withClientCertExclusionPaths
(String clientCertExclusionPaths) Set the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.withClientCertMode
(ClientCertMode clientCertMode) Set the clientCertMode property: This composes with ClientCertEnabled settingwithCloningInfo
(CloningInfo cloningInfo) Set the cloningInfo property: If specified during app creation, the app is cloned from a source app.withContainerSize
(Integer containerSize) Set the containerSize property: Size of the function container.withCustomDomainVerificationId
(String customDomainVerificationId) Set the customDomainVerificationId property: Unique identifier that verifies the custom domains assigned to the app.withDailyMemoryTimeQuota
(Integer dailyMemoryTimeQuota) Set the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).withDnsConfiguration
(SiteDnsConfig dnsConfiguration) Set the dnsConfiguration property: Property to configure various DNS related settings for a site.withEnabled
(Boolean enabled) Set the enabled property: <code>true</code> if the app is enabled; otherwise, <code>false</code>.withHostingEnvironmentProfile
(HostingEnvironmentProfile hostingEnvironmentProfile) Set the hostingEnvironmentProfile property: App Service Environment to use for the app.withHostNamesDisabled
(Boolean hostNamesDisabled) Set the hostNamesDisabled property: <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.withHostnameSslStates
(List<HostnameSslState> hostnameSslStates) Set the hostnameSslStates property: Hostname SSL states are used to manage the SSL bindings for app's hostnames.withHttpsOnly
(Boolean httpsOnly) Set the httpsOnly property: HttpsOnly: configures a web site to accept only https requests.withHyperV
(Boolean hyperV) Set the hyperV property: Hyper-V sandbox.withIsXenon
(Boolean isXenon) Set the isXenon property: Obsolete: Hyper-V sandbox.withKeyVaultReferenceIdentity
(String keyVaultReferenceIdentity) Set the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.withRedundancyMode
(RedundancyMode redundancyMode) Set the redundancyMode property: Site redundancy mode.withReserved
(Boolean reserved) Set the reserved property: <code>true</code> if reserved; otherwise, <code>false</code>.withScmSiteAlsoStopped
(Boolean scmSiteAlsoStopped) Set the scmSiteAlsoStopped property: <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>.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}".withSiteConfig
(SiteConfigInner siteConfig) Set the siteConfig property: Configuration of the app.withStorageAccountRequired
(Boolean storageAccountRequired) Set the storageAccountRequired property: Checks if Customer provided storage account is required.withVirtualNetworkSubnetId
(String virtualNetworkSubnetId) Set the virtualNetworkSubnetId property: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
SitePatchResourcePropertiesInner
public SitePatchResourcePropertiesInner()Creates an instance of SitePatchResourcePropertiesInner class.
-
-
Method Details
-
state
Get the state property: Current state of the app.- Returns:
- the state value.
-
hostNames
Get the hostNames property: Hostnames associated with the app.- Returns:
- the hostNames value.
-
repositorySiteName
Get the repositorySiteName property: Name of the repository site.- Returns:
- the repositorySiteName value.
-
usageState
Get the usageState property: State indicating whether the app has exceeded its quota usage. Read-only.- Returns:
- the usageState value.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
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
Get the availabilityState property: Management information availability state for the app.- Returns:
- the availabilityState value.
-
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 SitePatchResourcePropertiesInner 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 SitePatchResourcePropertiesInner object itself.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
reserved
Get the reserved property: <code>true</code> if reserved; otherwise, <code>false</code>.- Returns:
- the reserved value.
-
withReserved
Set the reserved property: <code>true</code> if reserved; otherwise, <code>false</code>.- Parameters:
reserved
- the reserved value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
isXenon
Get the isXenon property: Obsolete: Hyper-V sandbox.- Returns:
- the isXenon value.
-
withIsXenon
Set the isXenon property: Obsolete: Hyper-V sandbox.- Parameters:
isXenon
- the isXenon value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
hyperV
Get the hyperV property: Hyper-V sandbox.- Returns:
- the hyperV value.
-
withHyperV
Set the hyperV property: Hyper-V sandbox.- Parameters:
hyperV
- the hyperV value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
lastModifiedTimeUtc
Get the lastModifiedTimeUtc property: Last time the app was modified, in UTC. Read-only.- Returns:
- the lastModifiedTimeUtc value.
-
dnsConfiguration
Get the dnsConfiguration property: Property to configure various DNS related settings for a site.- Returns:
- the dnsConfiguration value.
-
withDnsConfiguration
Set the dnsConfiguration property: Property to configure various DNS related settings for a site.- Parameters:
dnsConfiguration
- the dnsConfiguration value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
siteConfig
Get the siteConfig property: Configuration of the app.- Returns:
- the siteConfig value.
-
withSiteConfig
Set the siteConfig property: Configuration of the app.- Parameters:
siteConfig
- the siteConfig value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
trafficManagerHostNames
Get the trafficManagerHostNames property: Azure Traffic Manager hostnames associated with the app. Read-only.- Returns:
- the trafficManagerHostNames value.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
targetSwapSlot
Get the targetSwapSlot property: Specifies which deployment slot this app will swap into. Read-only.- Returns:
- the targetSwapSlot value.
-
hostingEnvironmentProfile
Get the hostingEnvironmentProfile property: App Service Environment to use for the app.- Returns:
- the hostingEnvironmentProfile value.
-
withHostingEnvironmentProfile
public SitePatchResourcePropertiesInner withHostingEnvironmentProfile(HostingEnvironmentProfile hostingEnvironmentProfile) Set the hostingEnvironmentProfile property: App Service Environment to use for the app.- Parameters:
hostingEnvironmentProfile
- the hostingEnvironmentProfile value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
clientCertExclusionPaths
Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.- Returns:
- the clientCertExclusionPaths value.
-
withClientCertExclusionPaths
public SitePatchResourcePropertiesInner withClientCertExclusionPaths(String clientCertExclusionPaths) Set the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.- Parameters:
clientCertExclusionPaths
- the clientCertExclusionPaths value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
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 SitePatchResourcePropertiesInner 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 SitePatchResourcePropertiesInner object itself.
-
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
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
Get the containerSize property: Size of the function container.- Returns:
- the containerSize value.
-
withContainerSize
Set the containerSize property: Size of the function container.- Parameters:
containerSize
- the containerSize value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
dailyMemoryTimeQuota
Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).- Returns:
- the dailyMemoryTimeQuota value.
-
withDailyMemoryTimeQuota
Set the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).- Parameters:
dailyMemoryTimeQuota
- the dailyMemoryTimeQuota value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
suspendedTill
Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.- Returns:
- the suspendedTill value.
-
maxNumberOfWorkers
Get the maxNumberOfWorkers property: Maximum number of workers. This only applies to Functions container.- Returns:
- the maxNumberOfWorkers value.
-
cloningInfo
Get the cloningInfo property: If specified during app creation, the app is cloned from a source app.- Returns:
- the cloningInfo value.
-
withCloningInfo
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 SitePatchResourcePropertiesInner object itself.
-
resourceGroup
Get the resourceGroup property: Name of the resource group the app belongs to. Read-only.- Returns:
- the resourceGroup value.
-
isDefaultContainer
Get the isDefaultContainer property: <code>true</code> if the app is a default container; otherwise, <code>false</code>.- Returns:
- the isDefaultContainer value.
-
defaultHostname
Get the defaultHostname property: Default hostname of the app. Read-only.- Returns:
- the defaultHostname value.
-
slotSwapStatus
Get the slotSwapStatus property: Status of the last deployment slot swap operation.- Returns:
- the slotSwapStatus value.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
redundancyMode
Get the redundancyMode property: Site redundancy mode.- Returns:
- the redundancyMode value.
-
withRedundancyMode
Set the redundancyMode property: Site redundancy mode.- Parameters:
redundancyMode
- the redundancyMode value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
inProgressOperationId
Get the inProgressOperationId property: Specifies an operation id if this site has a pending operation.- Returns:
- the inProgressOperationId value.
-
storageAccountRequired
Get the storageAccountRequired property: Checks if Customer provided storage account is required.- Returns:
- the storageAccountRequired value.
-
withStorageAccountRequired
Set the storageAccountRequired property: Checks if Customer provided storage account is required.- Parameters:
storageAccountRequired
- the storageAccountRequired value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
keyVaultReferenceIdentity
Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.- Returns:
- the keyVaultReferenceIdentity value.
-
withKeyVaultReferenceIdentity
public SitePatchResourcePropertiesInner withKeyVaultReferenceIdentity(String keyVaultReferenceIdentity) Set the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.- Parameters:
keyVaultReferenceIdentity
- the keyVaultReferenceIdentity value to set.- Returns:
- the SitePatchResourcePropertiesInner object itself.
-
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
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 SitePatchResourcePropertiesInner object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
toJson
- Specified by:
toJson
in interfacecom.azure.json.JsonSerializable<SitePatchResourcePropertiesInner>
- Throws:
IOException
-
fromJson
public static SitePatchResourcePropertiesInner fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of SitePatchResourcePropertiesInner from the JsonReader.- Parameters:
jsonReader
- The JsonReader being read.- Returns:
- An instance of SitePatchResourcePropertiesInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IOException
- If an error occurs while reading the SitePatchResourcePropertiesInner.
-