SiteInner Class

Package:

com.azure.resourcemanager.appservice.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.45.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.appservice.fluent.models.SiteInner

public final class SiteInner
extends Resource

A web app, a mobile app backend, or an API app.

Constructor Summary

Constructor	Description
SiteInner()	Creates an instance of SiteInner class.

Method Summary

Modifier and Type	Method and Description
AutoGeneratedDomainNameLabelScope	autoGeneratedDomainNameLabelScope() Get the autoGeneratedDomainNameLabelScope property: Specifies the scope of uniqueness for the default hostname during resource creation.
SiteAvailabilityState	availabilityState() Get the availabilityState property: Management information availability state for the app.
Boolean	clientAffinityEnabled() Get the clientAffinityEnabled property: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance.
Boolean	clientCertEnabled() Get the clientCertEnabled property: true to enable client certificate authentication (TLS mutual authentication); otherwise, false.
String	clientCertExclusionPaths() Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.
ClientCertMode	clientCertMode() Get the clientCertMode property: This composes with ClientCertEnabled setting.
CloningInfo	cloningInfo() Get the cloningInfo property: If specified during app creation, the app is cloned from a source app.
Integer	containerSize() Get the containerSize property: Size of the function container.
String	customDomainVerificationId() Get the customDomainVerificationId property: Unique identifier that verifies the custom domains assigned to the app.
Integer	dailyMemoryTimeQuota() Get the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
DaprConfig	daprConfig() Get the daprConfig property: Dapr configuration of the app.
String	defaultHostname() Get the defaultHostname property: Default hostname of the app.
SiteDnsConfig	dnsConfiguration() Get the dnsConfiguration property: Property to configure various DNS related settings for a site.
Boolean	enabled() Get the enabled property: true if the app is enabled; otherwise, false.
List<String>	enabledHostNames() Get the enabledHostNames property: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled.
Boolean	endToEndEncryptionEnabled() Get the endToEndEncryptionEnabled property: Whether to use end to end encryption between the FrontEnd and the Worker.
ExtendedLocation	extendedLocation() Get the extendedLocation property: Extended Location.
static SiteInner	fromJson(JsonReader jsonReader) Reads an instance of SiteInner from the JsonReader.
FunctionAppConfig	functionAppConfig() Get the functionAppConfig property: Configuration specific of the Azure Function app.
List<String>	hostNames() Get the hostNames property: Hostnames associated with the app.
Boolean	hostNamesDisabled() Get the hostNamesDisabled property: true to disable the public hostnames of the app; otherwise, false.
HostingEnvironmentProfile	hostingEnvironmentProfile() Get the hostingEnvironmentProfile property: App Service Environment to use for the app.
List<HostnameSslState>	hostnameSslStates() Get the hostnameSslStates property: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
Boolean	httpsOnly() Get the httpsOnly property: HttpsOnly: configures a web site to accept only https requests.
Boolean	hyperV() Get the hyperV property: Hyper-V sandbox.
String	id() Get the id property: Fully qualified resource Id for the resource.
ManagedServiceIdentity	identity() Get the identity property: Managed service identity.
UUID	inProgressOperationId() Get the inProgressOperationId property: Specifies an operation id if this site has a pending operation.
IpMode	ipMode() Get the ipMode property: Specifies the IP mode of the app.
Boolean	isDefaultContainer() Get the isDefaultContainer property: true if the app is a default container; otherwise, false.
Boolean	isXenon() Get the isXenon property: Obsolete: Hyper-V sandbox.
String	keyVaultReferenceIdentity() Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.
String	kind() Get the kind property: Kind of resource.
OffsetDateTime	lastModifiedTimeUtc() Get the lastModifiedTimeUtc property: Last time the app was modified, in UTC.
String	managedEnvironmentId() Get the managedEnvironmentId property: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app.
Integer	maxNumberOfWorkers() Get the maxNumberOfWorkers property: Maximum number of workers.
String	name() Get the name property: The name of the resource.
String	outboundIpAddresses() Get the outboundIpAddresses property: List of IP addresses that the app uses for outbound connections (e.g.
String	possibleOutboundIpAddresses() Get the possibleOutboundIpAddresses property: List of IP addresses that the app uses for outbound connections (e.g.
String	publicNetworkAccess() Get the publicNetworkAccess property: Property to allow or block all public traffic.
RedundancyMode	redundancyMode() Get the redundancyMode property: Site redundancy mode.
String	repositorySiteName() Get the repositorySiteName property: Name of the repository site.
Boolean	reserved() Get the reserved property: true if reserved; otherwise, false.
ResourceConfig	resourceConfig() Get the resourceConfig property: Function app resource requirements.
String	resourceGroup() Get the resourceGroup property: Name of the resource group the app belongs to.
Boolean	scmSiteAlsoStopped() Get the scmSiteAlsoStopped property: true to stop SCM (KUDU) site when the app is stopped; otherwise, false.
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}".
SiteConfigInner	siteConfig() Get the siteConfig property: Configuration of the app.
String	sku() Get the sku property: Current SKU of application based on associated App Service Plan.
SlotSwapStatus	slotSwapStatus() Get the slotSwapStatus property: Status of the last deployment slot swap operation.
String	state() Get the state property: Current state of the app.
Boolean	storageAccountRequired() Get the storageAccountRequired property: Checks if Customer provided storage account is required.
OffsetDateTime	suspendedTill() Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.
String	targetSwapSlot() Get the targetSwapSlot property: Specifies which deployment slot this app will swap into.
JsonWriter	toJson(JsonWriter jsonWriter)
List<String>	trafficManagerHostNames() Get the trafficManagerHostNames property: Azure Traffic Manager hostnames associated with the app.
String	type() Get the type property: The type of the resource.
UsageState	usageState() Get the usageState property: State indicating whether the app has exceeded its quota usage.
void	validate() Validates the instance.
String	virtualNetworkSubnetId() Get the virtualNetworkSubnetId property: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.
Boolean	vnetBackupRestoreEnabled() Get the vnetBackupRestoreEnabled property: To enable Backup and Restore operations over virtual network.
Boolean	vnetContentShareEnabled() Get the vnetContentShareEnabled property: To enable accessing content over virtual network.
Boolean	vnetImagePullEnabled() Get the vnetImagePullEnabled property: To enable pulling image over Virtual Network.
Boolean	vnetRouteAllEnabled() Get the vnetRouteAllEnabled property: Virtual Network Route All enabled.
SiteInner	withAutoGeneratedDomainNameLabelScope(AutoGeneratedDomainNameLabelScope autoGeneratedDomainNameLabelScope) Set the autoGeneratedDomainNameLabelScope property: Specifies the scope of uniqueness for the default hostname during resource creation.
SiteInner	withClientAffinityEnabled(Boolean clientAffinityEnabled) Set the clientAffinityEnabled property: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance.
SiteInner	withClientCertEnabled(Boolean clientCertEnabled) Set the clientCertEnabled property: true to enable client certificate authentication (TLS mutual authentication); otherwise, false.
SiteInner	withClientCertExclusionPaths(String clientCertExclusionPaths) Set the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.
SiteInner	withClientCertMode(ClientCertMode clientCertMode) Set the clientCertMode property: This composes with ClientCertEnabled setting.
SiteInner	withCloningInfo(CloningInfo cloningInfo) Set the cloningInfo property: If specified during app creation, the app is cloned from a source app.
SiteInner	withContainerSize(Integer containerSize) Set the containerSize property: Size of the function container.
SiteInner	withCustomDomainVerificationId(String customDomainVerificationId) Set the customDomainVerificationId property: Unique identifier that verifies the custom domains assigned to the app.
SiteInner	withDailyMemoryTimeQuota(Integer dailyMemoryTimeQuota) Set the dailyMemoryTimeQuota property: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
SiteInner	withDaprConfig(DaprConfig daprConfig) Set the daprConfig property: Dapr configuration of the app.
SiteInner	withDnsConfiguration(SiteDnsConfig dnsConfiguration) Set the dnsConfiguration property: Property to configure various DNS related settings for a site.
SiteInner	withEnabled(Boolean enabled) Set the enabled property: true if the app is enabled; otherwise, false.
SiteInner	withEndToEndEncryptionEnabled(Boolean endToEndEncryptionEnabled) Set the endToEndEncryptionEnabled property: Whether to use end to end encryption between the FrontEnd and the Worker.
SiteInner	withExtendedLocation(ExtendedLocation extendedLocation) Set the extendedLocation property: Extended Location.
SiteInner	withFunctionAppConfig(FunctionAppConfig functionAppConfig) Set the functionAppConfig property: Configuration specific of the Azure Function app.
SiteInner	withHostNamesDisabled(Boolean hostNamesDisabled) Set the hostNamesDisabled property: true to disable the public hostnames of the app; otherwise, false.
SiteInner	withHostingEnvironmentProfile(HostingEnvironmentProfile hostingEnvironmentProfile) Set the hostingEnvironmentProfile property: App Service Environment to use for the app.
SiteInner	withHostnameSslStates(List<HostnameSslState> hostnameSslStates) Set the hostnameSslStates property: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
SiteInner	withHttpsOnly(Boolean httpsOnly) Set the httpsOnly property: HttpsOnly: configures a web site to accept only https requests.
SiteInner	withHyperV(Boolean hyperV) Set the hyperV property: Hyper-V sandbox.
SiteInner	withIdentity(ManagedServiceIdentity identity) Set the identity property: Managed service identity.
SiteInner	withIpMode(IpMode ipMode) Set the ipMode property: Specifies the IP mode of the app.
SiteInner	withIsXenon(Boolean isXenon) Set the isXenon property: Obsolete: Hyper-V sandbox.
SiteInner	withKeyVaultReferenceIdentity(String keyVaultReferenceIdentity) Set the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.
SiteInner	withKind(String kind) Set the kind property: Kind of resource.
SiteInner	withLocation(String location)
SiteInner	withManagedEnvironmentId(String managedEnvironmentId) Set the managedEnvironmentId property: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app.
SiteInner	withPublicNetworkAccess(String publicNetworkAccess) Set the publicNetworkAccess property: Property to allow or block all public traffic.
SiteInner	withRedundancyMode(RedundancyMode redundancyMode) Set the redundancyMode property: Site redundancy mode.
SiteInner	withReserved(Boolean reserved) Set the reserved property: true if reserved; otherwise, false.
SiteInner	withResourceConfig(ResourceConfig resourceConfig) Set the resourceConfig property: Function app resource requirements.
SiteInner	withScmSiteAlsoStopped(Boolean scmSiteAlsoStopped) Set the scmSiteAlsoStopped property: true to stop SCM (KUDU) site when the app is stopped; otherwise, false.
SiteInner	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}".
SiteInner	withSiteConfig(SiteConfigInner siteConfig) Set the siteConfig property: Configuration of the app.
SiteInner	withStorageAccountRequired(Boolean storageAccountRequired) Set the storageAccountRequired property: Checks if Customer provided storage account is required.
SiteInner	withTags(Map<String,String> tags)
SiteInner	withVirtualNetworkSubnetId(String virtualNetworkSubnetId) Set the virtualNetworkSubnetId property: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.
SiteInner	withVnetBackupRestoreEnabled(Boolean vnetBackupRestoreEnabled) Set the vnetBackupRestoreEnabled property: To enable Backup and Restore operations over virtual network.
SiteInner	withVnetContentShareEnabled(Boolean vnetContentShareEnabled) Set the vnetContentShareEnabled property: To enable accessing content over virtual network.
SiteInner	withVnetImagePullEnabled(Boolean vnetImagePullEnabled) Set the vnetImagePullEnabled property: To enable pulling image over Virtual Network.
SiteInner	withVnetRouteAllEnabled(Boolean vnetRouteAllEnabled) Set the vnetRouteAllEnabled property: Virtual Network Route All enabled.
SiteInner	withWorkloadProfileName(String workloadProfileName) Set the workloadProfileName property: Workload profile name for function app to execute on.
String	workloadProfileName() Get the workloadProfileName property: Workload profile name for function app to execute on.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SiteInner

public SiteInner()

Creates an instance of SiteInner class.

Method Details

autoGeneratedDomainNameLabelScope

public AutoGeneratedDomainNameLabelScope autoGeneratedDomainNameLabelScope()

Get the autoGeneratedDomainNameLabelScope property: Specifies the scope of uniqueness for the default hostname during resource creation.

Returns:

the autoGeneratedDomainNameLabelScope value.

availabilityState

public SiteAvailabilityState availabilityState()

Get the availabilityState property: Management information availability state for the app.

Returns:

the availabilityState value.

clientAffinityEnabled

public Boolean clientAffinityEnabled()

Get the clientAffinityEnabled property: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Returns:

the clientAffinityEnabled value.

clientCertEnabled

public Boolean clientCertEnabled()

Get the clientCertEnabled property: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

Returns:

the clientCertEnabled value.

clientCertExclusionPaths

public String clientCertExclusionPaths()

Get the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.

Returns:

the clientCertExclusionPaths value.

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.

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.

containerSize

public Integer containerSize()

Get the containerSize property: Size of the function container.

Returns:

the containerSize value.

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.

dailyMemoryTimeQuota

public Integer dailyMemoryTimeQuota()

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

Returns:

the dailyMemoryTimeQuota value.

daprConfig

public DaprConfig daprConfig()

Get the daprConfig property: Dapr configuration of the app.

Returns:

the daprConfig value.

defaultHostname

public String defaultHostname()

Get the defaultHostname property: Default hostname of the app. Read-only.

Returns:

the defaultHostname value.

dnsConfiguration

public SiteDnsConfig dnsConfiguration()

Get the dnsConfiguration property: Property to configure various DNS related settings for a site.

Returns:

the dnsConfiguration value.

enabled

public Boolean enabled()

Get the enabled property: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

Returns:

the enabled value.

enabledHostNames

public List 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.

endToEndEncryptionEnabled

public Boolean endToEndEncryptionEnabled()

Get the endToEndEncryptionEnabled property: Whether to use end to end encryption between the FrontEnd and the Worker.

Returns:

the endToEndEncryptionEnabled value.

extendedLocation

public ExtendedLocation extendedLocation()

Get the extendedLocation property: Extended Location.

Returns:

the extendedLocation value.

fromJson

public static SiteInner fromJson(JsonReader jsonReader)

Reads an instance of SiteInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SiteInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

functionAppConfig

public FunctionAppConfig functionAppConfig()

Get the functionAppConfig property: Configuration specific of the Azure Function app.

Returns:

the functionAppConfig value.

hostNames

public List hostNames()

Get the hostNames property: Hostnames associated with the app.

Returns:

the hostNames value.

hostNamesDisabled

public Boolean hostNamesDisabled()

Get the hostNamesDisabled property: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

Returns:

the hostNamesDisabled value.

hostingEnvironmentProfile

public HostingEnvironmentProfile hostingEnvironmentProfile()

Get the hostingEnvironmentProfile property: App Service Environment to use for the app.

Returns:

the hostingEnvironmentProfile value.

hostnameSslStates

public List hostnameSslStates()

Get the hostnameSslStates property: Hostname SSL states are used to manage the SSL bindings for app's hostnames.

Returns:

the hostnameSslStates 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.

hyperV

public Boolean hyperV()

Get the hyperV property: Hyper-V sandbox.

Returns:

the hyperV value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

SiteInner.id()

Returns:

the id value.

identity

public ManagedServiceIdentity identity()

Get the identity property: Managed service identity.

Returns:

the identity value.

inProgressOperationId

public UUID inProgressOperationId()

Get the inProgressOperationId property: Specifies an operation id if this site has a pending operation.

Returns:

the inProgressOperationId value.

ipMode

public IpMode ipMode()

Get the ipMode property: Specifies the IP mode of the app.

Returns:

the ipMode value.

isDefaultContainer

public Boolean isDefaultContainer()

Get the isDefaultContainer property: true if the app is a default container; otherwise, false.

Returns:

the isDefaultContainer value.

isXenon

public Boolean isXenon()

Get the isXenon property: Obsolete: Hyper-V sandbox.

Returns:

the isXenon value.

keyVaultReferenceIdentity

public String keyVaultReferenceIdentity()

Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.

Returns:

the keyVaultReferenceIdentity value.

kind

public String kind()

Get the kind property: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things\_You\_Should\_Know/kind\_property.md\#app-service-resource-kind-reference for details supported values for kind.

Returns:

the kind value.

lastModifiedTimeUtc

public OffsetDateTime lastModifiedTimeUtc()

Get the lastModifiedTimeUtc property: Last time the app was modified, in UTC. Read-only.

Returns:

the lastModifiedTimeUtc value.

managedEnvironmentId

public String managedEnvironmentId()

Get the managedEnvironmentId property: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}.

Returns:

the managedEnvironmentId value.

maxNumberOfWorkers

public Integer maxNumberOfWorkers()

Get the maxNumberOfWorkers property: Maximum number of workers. This only applies to Functions container.

Returns:

the maxNumberOfWorkers value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

SiteInner.name()

Returns:

the name value.

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.

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.

redundancyMode

public RedundancyMode redundancyMode()

Get the redundancyMode property: Site redundancy mode.

Returns:

the redundancyMode value.

repositorySiteName

public String repositorySiteName()

Get the repositorySiteName property: Name of the repository site.

Returns:

the repositorySiteName value.

reserved

public Boolean reserved()

Get the reserved property: true if reserved; otherwise, false.

Returns:

the reserved value.

resourceConfig

public ResourceConfig resourceConfig()

Get the resourceConfig property: Function app resource requirements.

Returns:

the resourceConfig value.

resourceGroup

public String resourceGroup()

Get the resourceGroup property: Name of the resource group the app belongs to. Read-only.

Returns:

the resourceGroup value.

scmSiteAlsoStopped

public Boolean scmSiteAlsoStopped()

Get the scmSiteAlsoStopped property: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

Returns:

the scmSiteAlsoStopped value.

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.

siteConfig

public SiteConfigInner siteConfig()

Get the siteConfig property: Configuration of the app.

Returns:

the siteConfig value.

sku

public String sku()

Get the sku property: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2.

Returns:

the sku value.

slotSwapStatus

public SlotSwapStatus slotSwapStatus()

Get the slotSwapStatus property: Status of the last deployment slot swap operation.

Returns:

the slotSwapStatus value.

state

public String state()

Get the state property: Current state of the app.

Returns:

the state value.

storageAccountRequired

public Boolean storageAccountRequired()

Get the storageAccountRequired property: Checks if Customer provided storage account is required.

Returns:

the storageAccountRequired value.

suspendedTill

public OffsetDateTime suspendedTill()

Get the suspendedTill property: App suspended till in case memory-time quota is exceeded.

Returns:

the suspendedTill value.

targetSwapSlot

public String targetSwapSlot()

Get the targetSwapSlot property: Specifies which deployment slot this app will swap into. Read-only.

Returns:

the targetSwapSlot value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SiteInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

trafficManagerHostNames

public List trafficManagerHostNames()

Get the trafficManagerHostNames property: Azure Traffic Manager hostnames associated with the app. Read-only.

Returns:

the trafficManagerHostNames value.

type

public String type()

Get the type property: The type of the resource.

Overrides:

SiteInner.type()

Returns:

the type 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.

validate

public void validate()

Validates the instance.

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.

vnetBackupRestoreEnabled

public Boolean vnetBackupRestoreEnabled()

Get the vnetBackupRestoreEnabled property: To enable Backup and Restore operations over virtual network.

Returns:

the vnetBackupRestoreEnabled value.

vnetContentShareEnabled

public Boolean vnetContentShareEnabled()

Get the vnetContentShareEnabled property: To enable accessing content over virtual network.

Returns:

the vnetContentShareEnabled value.

vnetImagePullEnabled

public Boolean vnetImagePullEnabled()

Get the vnetImagePullEnabled property: To enable pulling image over Virtual Network.

Returns:

the vnetImagePullEnabled value.

vnetRouteAllEnabled

public Boolean vnetRouteAllEnabled()

Get the vnetRouteAllEnabled property: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

Returns:

the vnetRouteAllEnabled value.

withAutoGeneratedDomainNameLabelScope

public SiteInner withAutoGeneratedDomainNameLabelScope(AutoGeneratedDomainNameLabelScope autoGeneratedDomainNameLabelScope)

Set the autoGeneratedDomainNameLabelScope property: Specifies the scope of uniqueness for the default hostname during resource creation.

Parameters:

autoGeneratedDomainNameLabelScope - the autoGeneratedDomainNameLabelScope value to set.

Returns:

the SiteInner object itself.

withClientAffinityEnabled

public SiteInner withClientAffinityEnabled(Boolean clientAffinityEnabled)

Set the clientAffinityEnabled property: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Parameters:

clientAffinityEnabled - the clientAffinityEnabled value to set.

Returns:

the SiteInner object itself.

withClientCertEnabled

public SiteInner withClientCertEnabled(Boolean clientCertEnabled)

Set the clientCertEnabled property: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

Parameters:

clientCertEnabled - the clientCertEnabled value to set.

Returns:

the SiteInner object itself.

withClientCertExclusionPaths

public SiteInner withClientCertExclusionPaths(String clientCertExclusionPaths)

Set the clientCertExclusionPaths property: client certificate authentication comma-separated exclusion paths.

Parameters:

clientCertExclusionPaths - the clientCertExclusionPaths value to set.

Returns:

the SiteInner object itself.

withClientCertMode

public SiteInner 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 SiteInner object itself.

withCloningInfo

public SiteInner 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 SiteInner object itself.

withContainerSize

public SiteInner withContainerSize(Integer containerSize)

Set the containerSize property: Size of the function container.

Parameters:

containerSize - the containerSize value to set.

Returns:

the SiteInner object itself.

withCustomDomainVerificationId

public SiteInner 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 SiteInner object itself.

withDailyMemoryTimeQuota

public SiteInner 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 SiteInner object itself.

withDaprConfig

public SiteInner withDaprConfig(DaprConfig daprConfig)

Set the daprConfig property: Dapr configuration of the app.

Parameters:

daprConfig - the daprConfig value to set.

Returns:

the SiteInner object itself.

withDnsConfiguration

public SiteInner 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 SiteInner object itself.

withEnabled

public SiteInner withEnabled(Boolean enabled)

Set the enabled property: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

Parameters:

enabled - the enabled value to set.

Returns:

the SiteInner object itself.

withEndToEndEncryptionEnabled

public SiteInner withEndToEndEncryptionEnabled(Boolean endToEndEncryptionEnabled)

Set the endToEndEncryptionEnabled property: Whether to use end to end encryption between the FrontEnd and the Worker.

Parameters:

endToEndEncryptionEnabled - the endToEndEncryptionEnabled value to set.

Returns:

the SiteInner object itself.

withExtendedLocation

public SiteInner withExtendedLocation(ExtendedLocation extendedLocation)

Set the extendedLocation property: Extended Location.

Parameters:

extendedLocation - the extendedLocation value to set.

Returns:

the SiteInner object itself.

withFunctionAppConfig

public SiteInner withFunctionAppConfig(FunctionAppConfig functionAppConfig)

Set the functionAppConfig property: Configuration specific of the Azure Function app.

Parameters:

functionAppConfig - the functionAppConfig value to set.

Returns:

the SiteInner object itself.

withHostNamesDisabled

public SiteInner withHostNamesDisabled(Boolean hostNamesDisabled)

Set the hostNamesDisabled property: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

Parameters:

hostNamesDisabled - the hostNamesDisabled value to set.

Returns:

the SiteInner object itself.

withHostingEnvironmentProfile

public SiteInner withHostingEnvironmentProfile(HostingEnvironmentProfile hostingEnvironmentProfile)

Set the hostingEnvironmentProfile property: App Service Environment to use for the app.

Parameters:

hostingEnvironmentProfile - the hostingEnvironmentProfile value to set.

Returns:

the SiteInner object itself.

withHostnameSslStates

public SiteInner withHostnameSslStates(List 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 SiteInner object itself.

withHttpsOnly

public SiteInner 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 SiteInner object itself.

withHyperV

public SiteInner withHyperV(Boolean hyperV)

Set the hyperV property: Hyper-V sandbox.

Parameters:

hyperV - the hyperV value to set.

Returns:

the SiteInner object itself.

withIdentity

public SiteInner withIdentity(ManagedServiceIdentity identity)

Set the identity property: Managed service identity.

Parameters:

identity - the identity value to set.

Returns:

the SiteInner object itself.

withIpMode

public SiteInner withIpMode(IpMode ipMode)

Set the ipMode property: Specifies the IP mode of the app.

Parameters:

ipMode - the ipMode value to set.

Returns:

the SiteInner object itself.

withIsXenon

public SiteInner withIsXenon(Boolean isXenon)

Set the isXenon property: Obsolete: Hyper-V sandbox.

Parameters:

isXenon - the isXenon value to set.

Returns:

the SiteInner object itself.

withKeyVaultReferenceIdentity

public SiteInner withKeyVaultReferenceIdentity(String keyVaultReferenceIdentity)

Set the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.

Parameters:

keyVaultReferenceIdentity - the keyVaultReferenceIdentity value to set.

Returns:

the SiteInner object itself.

withKind

public SiteInner withKind(String kind)

Set the kind property: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things\_You\_Should\_Know/kind\_property.md\#app-service-resource-kind-reference for details supported values for kind.

Parameters:

kind - the kind value to set.

Returns:

the SiteInner object itself.

withLocation

public SiteInner withLocation(String location)

Overrides:

SiteInner.withLocation(String location)

Parameters:

location

withManagedEnvironmentId

public SiteInner withManagedEnvironmentId(String managedEnvironmentId)

Set the managedEnvironmentId property: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}.

Parameters:

managedEnvironmentId - the managedEnvironmentId value to set.

Returns:

the SiteInner object itself.

withPublicNetworkAccess

public SiteInner 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 SiteInner object itself.

withRedundancyMode

public SiteInner withRedundancyMode(RedundancyMode redundancyMode)

Set the redundancyMode property: Site redundancy mode.

Parameters:

redundancyMode - the redundancyMode value to set.

Returns:

the SiteInner object itself.

withReserved

public SiteInner withReserved(Boolean reserved)

Set the reserved property: true if reserved; otherwise, false.

Parameters:

reserved - the reserved value to set.

Returns:

the SiteInner object itself.

withResourceConfig

public SiteInner withResourceConfig(ResourceConfig resourceConfig)

Set the resourceConfig property: Function app resource requirements.

Parameters:

resourceConfig - the resourceConfig value to set.

Returns:

the SiteInner object itself.

withScmSiteAlsoStopped

public SiteInner withScmSiteAlsoStopped(Boolean scmSiteAlsoStopped)

Set the scmSiteAlsoStopped property: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

Parameters:

scmSiteAlsoStopped - the scmSiteAlsoStopped value to set.

Returns:

the SiteInner object itself.

withServerFarmId

public SiteInner 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 SiteInner object itself.

withSiteConfig

public SiteInner withSiteConfig(SiteConfigInner siteConfig)

Set the siteConfig property: Configuration of the app.

Parameters:

siteConfig - the siteConfig value to set.

Returns:

the SiteInner object itself.

withStorageAccountRequired

public SiteInner withStorageAccountRequired(Boolean storageAccountRequired)

Set the storageAccountRequired property: Checks if Customer provided storage account is required.

Parameters:

storageAccountRequired - the storageAccountRequired value to set.

Returns:

the SiteInner object itself.

withTags

public SiteInner withTags(Map tags)

Overrides:

SiteInner.withTags(Map<String,String> tags)

Parameters:

tags

withVirtualNetworkSubnetId

public SiteInner 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 SiteInner object itself.

withVnetBackupRestoreEnabled

public SiteInner withVnetBackupRestoreEnabled(Boolean vnetBackupRestoreEnabled)

Set the vnetBackupRestoreEnabled property: To enable Backup and Restore operations over virtual network.

Parameters:

vnetBackupRestoreEnabled - the vnetBackupRestoreEnabled value to set.

Returns:

the SiteInner object itself.

withVnetContentShareEnabled

public SiteInner withVnetContentShareEnabled(Boolean vnetContentShareEnabled)

Set the vnetContentShareEnabled property: To enable accessing content over virtual network.

Parameters:

vnetContentShareEnabled - the vnetContentShareEnabled value to set.

Returns:

the SiteInner object itself.

withVnetImagePullEnabled

public SiteInner withVnetImagePullEnabled(Boolean vnetImagePullEnabled)

Set the vnetImagePullEnabled property: To enable pulling image over Virtual Network.

Parameters:

vnetImagePullEnabled - the vnetImagePullEnabled value to set.

Returns:

the SiteInner object itself.

withVnetRouteAllEnabled

public SiteInner withVnetRouteAllEnabled(Boolean vnetRouteAllEnabled)

Set the vnetRouteAllEnabled property: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

Parameters:

vnetRouteAllEnabled - the vnetRouteAllEnabled value to set.

Returns:

the SiteInner object itself.

withWorkloadProfileName

public SiteInner withWorkloadProfileName(String workloadProfileName)

Set the workloadProfileName property: Workload profile name for function app to execute on.

Parameters:

workloadProfileName - the workloadProfileName value to set.

Returns:

the SiteInner object itself.

workloadProfileName

public String workloadProfileName()

Get the workloadProfileName property: Workload profile name for function app to execute on.

Returns:

the workloadProfileName value.