Interface WebAppBase
- All Superinterfaces:
GroupableResource<AppServiceManager,
,SiteInner> HasId
,HasInnerModel<SiteInner>
,HasManager<AppServiceManager>
,HasName
,HasResourceGroup
,Indexable
,Resource
,WebSiteBase
- All Known Subinterfaces:
DeploymentSlot
,DeploymentSlotBase<FluentT>
,FunctionApp
,FunctionDeploymentSlot
,WebApp
public interface WebAppBase
extends HasName, GroupableResource<AppServiceManager,SiteInner>, WebSiteBase
An immutable client-side representation of an Azure Web App or deployment slot.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the web app base definition.static interface
Grouping of all the site definition stages.static interface
The template for a site update operation, containing all the settings that can be modified.static interface
Grouping of all the web app update stages.Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
Resource.DefinitionWithRegion<T extends Object>, Resource.DefinitionWithTags<T extends Object>, Resource.UpdateWithTags<T extends Object>
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
alwaysOn()
void
applySlotConfigurations
(String slotName) Apply the slot (or sticky) configurations from the specified slot to the current one.applySlotConfigurationsAsync
(String slotName) Apply the slot (or sticky) configurations from the specified slot to the current one.deploy()
First step specifying the parameters to make a web deployment (MS Deploy) to the web app.byte[]
Mono<byte[]>
byte[]
Mono<byte[]>
Gets the App Settings on site from Kudu client.Gets the App Settings on site from Kudu client.boolean
boolean
boolean
void
Reset the slot to its original configurations.Reset the slot to its original configurations.void
restart()
Restarts the web app or deployment slot.Restarts the web app or deployment slot.scmType()
void
start()
Starts the web app or deployment slot.Starts the web app or deployment slot.void
stop()
Stops the web app or deployment slot.Stops the web app or deployment slot.void
Swaps the app running in the current web app / slot with the app running in the specified slot.Swaps the app running in the current web app / slot with the app running in the specified slot.void
verifyDomainOwnership
(String certificateOrderName, String domainVerificationToken) Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app.verifyDomainOwnershipAsync
(String certificateOrderName, String domainVerificationToken) Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app.boolean
void
Deploys a ZIP file onto the Azure specialized Java SE image on this web app.void
zipDeploy
(InputStream zipFile, long length) Deploys a ZIP file onto the Azure specialized Java SE image on this web app.zipDeployAsync
(File zipFile) Deploys a ZIP file onto the Azure specialized Java SE image on this web app.zipDeployAsync
(InputStream zipFile, long length) Deploys a ZIP file onto the Azure specialized Java SE image on this web app.Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel
innerModel
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager
manager
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName
name
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupName
Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
region, regionName, tags, type
Methods inherited from interface com.azure.resourcemanager.appservice.models.WebSiteBase
appServicePlanId, availabilityState, clientAffinityEnabled, clientCertEnabled, clientCertExclusionPaths, cloningInfo, containerSize, dailyMemoryTimeQuota, defaultHostname, enabled, enabledHostNames, hostingEnvironmentProfile, hostnames, hostnamesDisabled, hostnameSslStates, httpsOnly, hyperV, identity, isDefaultContainer, lastModifiedTime, maxNumberOfWorkers, operatingSystem, outboundIPAddresses, possibleOutboundIpAddresses, redundancyMode, repositorySiteName, scmSiteAlsoStopped, slotSwapStatus, state, suspendedTill, targetSwapSlot, trafficManagerHostNames, usageState
-
Method Details
-
defaultDocuments
- Returns:
- the default documents
-
netFrameworkVersion
NetFrameworkVersion netFrameworkVersion()- Returns:
- the .NET Framework version
-
phpVersion
PhpVersion phpVersion()- Returns:
- the version of PHP
-
pythonVersion
PythonVersion pythonVersion()- Returns:
- the version of Python
-
nodeVersion
String nodeVersion()- Returns:
- the version of Node.JS
-
remoteDebuggingEnabled
boolean remoteDebuggingEnabled()- Returns:
- if the remote eebugging is enabled
-
remoteDebuggingVersion
RemoteVisualStudioVersion remoteDebuggingVersion()- Returns:
- the remote debugging version
-
webSocketsEnabled
boolean webSocketsEnabled()- Returns:
- if web socket is enabled
-
alwaysOn
boolean alwaysOn()- Returns:
- if the web app is always on
-
javaVersion
JavaVersion javaVersion()- Returns:
- Java version
-
javaContainer
String javaContainer()- Returns:
- Java container
-
javaContainerVersion
String javaContainerVersion()- Returns:
- Java container version
-
managedPipelineMode
ManagedPipelineMode managedPipelineMode()- Returns:
- managed pipeline mode
-
autoSwapSlotName
String autoSwapSlotName()- Returns:
- the auto swap slot name
-
ftpsState
FtpsState ftpsState()- Returns:
- the state of FTP / FTPS service
-
virtualApplications
List<VirtualApplication> virtualApplications()- Returns:
- the virtual applications and their virtual directories in this web app
-
http20Enabled
boolean http20Enabled()- Returns:
- whether to allow clients to connect over http2.0
-
minTlsVersion
SupportedTlsVersions minTlsVersion()- Returns:
- the minimum version of TLS required for SSL requests.
-
localMySqlEnabled
boolean localMySqlEnabled()- Returns:
- whether local MySQL is enabled
-
scmType
ScmType scmType()- Returns:
- the SCM configuration for the web app
-
documentRoot
String documentRoot()- Returns:
- the root directory for the web app
-
systemAssignedManagedServiceIdentityTenantId
String systemAssignedManagedServiceIdentityTenantId()- Returns:
- the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the web app.
-
systemAssignedManagedServiceIdentityPrincipalId
String systemAssignedManagedServiceIdentityPrincipalId()- Returns:
- the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the web app.
-
userAssignedManagedServiceIdentityIds
- Returns:
- The ids of the user assigned identities
-
getAppSettings
Map<String,AppSetting> getAppSettings()- Returns:
- the app settings defined on the web app
-
getAppSettingsAsync
Mono<Map<String,AppSetting>> getAppSettingsAsync()- Returns:
- the app settings defined on the web app
-
getConnectionStrings
Map<String,ConnectionString> getConnectionStrings()- Returns:
- the connection strings defined on the web app
-
getConnectionStringsAsync
Mono<Map<String,ConnectionString>> getConnectionStringsAsync()- Returns:
- the connection strings defined on the web app
-
getAuthenticationConfig
WebAppAuthentication getAuthenticationConfig()- Returns:
- the authentication configuration defined on the web app
-
getAuthenticationConfigAsync
Mono<WebAppAuthentication> getAuthenticationConfigAsync()- Returns:
- the authentication configuration defined on the web app
-
platformArchitecture
PlatformArchitecture platformArchitecture()- Returns:
- the architecture of the platform, either 32 bit (x86) or 64 bit (x64).
-
linuxFxVersion
String linuxFxVersion()- Returns:
- the Linux app framework and version if this is a Linux web app.
-
windowsFxVersion
String windowsFxVersion()- Returns:
- the Windows app framework and version if this is a Windows web app.
-
ipSecurityRules
List<IpSecurityRestriction> ipSecurityRules()- Returns:
- the list of ip security rules.
-
diagnosticLogsConfig
WebAppDiagnosticLogs diagnosticLogsConfig()- Returns:
- the diagnostic logs configuration
-
getHostnameBindings
Map<String,HostnameBinding> getHostnameBindings()- Returns:
- the mapping from host names and the host name bindings
-
getHostnameBindingsAsync
Mono<Map<String,HostnameBinding>> getHostnameBindingsAsync()- Returns:
- the mapping from host names and the host name bindings
-
getPublishingProfile
PublishingProfile getPublishingProfile()- Returns:
- the URL and credentials for publishing through FTP or Git
-
getPublishingProfileAsync
Mono<PublishingProfile> getPublishingProfileAsync()- Returns:
- the URL and credentials for publishing through FTP or Git
-
getSourceControl
WebAppSourceControl getSourceControl()- Returns:
- the source control information for the web app
-
getSourceControlAsync
Mono<WebAppSourceControl> getSourceControlAsync()- Returns:
- the source control information for the web app
-
deploy
First step specifying the parameters to make a web deployment (MS Deploy) to the web app.- Returns:
- a stage to create web deployment
-
getContainerLogs
byte[] getContainerLogs()- Returns:
- the last lines of docker logs for a Linux web app
-
getContainerLogsAsync
Mono<byte[]> getContainerLogsAsync()- Returns:
- the last lines of docker logs for a Linux web app
-
getContainerLogsZip
byte[] getContainerLogsZip()- Returns:
- the zipped archive of docker logs for a Linux web app
-
getContainerLogsZipAsync
Mono<byte[]> getContainerLogsZipAsync()- Returns:
- the zipped archive of docker logs for a Linux web app
-
streamApplicationLogs
InputStream streamApplicationLogs()- Returns:
- a open stream to the application logs
-
streamHttpLogs
InputStream streamHttpLogs()- Returns:
- a open stream to the HTTP logs
-
streamTraceLogs
InputStream streamTraceLogs()- Returns:
- a open stream to the trace logs
-
streamDeploymentLogs
InputStream streamDeploymentLogs()- Returns:
- a open stream to the deployment logs
-
streamAllLogs
InputStream streamAllLogs()- Returns:
- a open stream to all logs
-
streamApplicationLogsAsync
- Returns:
- an Observable streaming application logs
-
streamHttpLogsAsync
- Returns:
- an Observable streaming HTTP logs
-
streamTraceLogsAsync
- Returns:
- an Observable streaming trace logs
-
streamDeploymentLogsAsync
- Returns:
- an Observable streaming deployment logs
-
streamAllLogsAsync
- Returns:
- an Observable streaming all logs
-
verifyDomainOwnership
Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app.- Parameters:
certificateOrderName
- the name of the certificate orderdomainVerificationToken
- the domain verification token for the certificate order
-
verifyDomainOwnershipAsync
Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app.- Parameters:
certificateOrderName
- the name of the certificate orderdomainVerificationToken
- the domain verification token for the certificate order- Returns:
- a representation of the deferred computation of this call
-
start
void start()Starts the web app or deployment slot. -
startAsync
Starts the web app or deployment slot.- Returns:
- a representation of the deferred computation of this call
-
stop
void stop()Stops the web app or deployment slot. -
stopAsync
Stops the web app or deployment slot.- Returns:
- a representation of the deferred computation of this call
-
restart
void restart()Restarts the web app or deployment slot. -
restartAsync
Restarts the web app or deployment slot.- Returns:
- a representation of the deferred computation of this call
-
swap
Swaps the app running in the current web app / slot with the app running in the specified slot.- Parameters:
slotName
- the target slot to swap with. Use 'production' for the production slot.
-
swapAsync
Swaps the app running in the current web app / slot with the app running in the specified slot.- Parameters:
slotName
- the target slot to swap with. Use 'production' for the production slot.- Returns:
- a representation of the deferred computation of this call
-
applySlotConfigurations
Apply the slot (or sticky) configurations from the specified slot to the current one. This is useful for "Swap with Preview".- Parameters:
slotName
- the target slot to apply configurations from
-
applySlotConfigurationsAsync
Apply the slot (or sticky) configurations from the specified slot to the current one. This is useful for "Swap with Preview".- Parameters:
slotName
- the target slot to apply configurations from- Returns:
- a representation of the deferred computation of this call
-
resetSlotConfigurations
void resetSlotConfigurations()Reset the slot to its original configurations. -
resetSlotConfigurationsAsync
Reset the slot to its original configurations.- Returns:
- a representation of the deferred computation of this call
-
zipDeploy
Deploys a ZIP file onto the Azure specialized Java SE image on this web app.- Parameters:
zipFile
- the ZIP file to upload
-
zipDeployAsync
Deploys a ZIP file onto the Azure specialized Java SE image on this web app.- Parameters:
zipFile
- the ZIP file to upload- Returns:
- a completable of the operation
-
zipDeploy
Deploys a ZIP file onto the Azure specialized Java SE image on this web app.Retry by client is required if error happens, due to nature of the stream.
- Parameters:
zipFile
- the ZIP file to uploadlength
- the length of the file
-
zipDeployAsync
Deploys a ZIP file onto the Azure specialized Java SE image on this web app.Retry by client is required if error happens, due to nature of the stream.
- Parameters:
zipFile
- the ZIP file to uploadlength
- the length of the file- Returns:
- a completable of the operation
-
getSiteAppSettings
Gets the App Settings on site from Kudu client. It might lag after App Setting update to the site.- Returns:
- the App Settings on site from Kudu client
-
getSiteAppSettingsAsync
Gets the App Settings on site from Kudu client. It might lag after App Setting update to the site.- Returns:
- the App Settings on site from Kudu client
-