Package com.microsoft.azure.toolkit.lib.appservice.function

Class FunctionAppBase<T extends FunctionAppBase<T,P,F>,P extends com.microsoft.azure.toolkit.lib.common.model.AbstractAzResource<P,?,?>,F extends com.azure.resourcemanager.appservice.models.WebAppBase>

java.lang.Object

com.microsoft.azure.toolkit.lib.common.model.AbstractAzResource<T,P,com.azure.resourcemanager.appservice.models.WebSiteBase>

com.microsoft.azure.toolkit.lib.appservice.AppServiceAppBase<T,P,F>

com.microsoft.azure.toolkit.lib.appservice.function.FunctionAppBase<T,P,F>

All Implemented Interfaces:

com.microsoft.azure.toolkit.lib.common.model.AzResource, com.microsoft.azure.toolkit.lib.common.model.AzResourceBase, com.microsoft.azure.toolkit.lib.common.model.Deletable, com.microsoft.azure.toolkit.lib.common.model.Refreshable, com.microsoft.azure.toolkit.lib.common.model.Startable

Direct Known Subclasses:

FunctionApp, FunctionAppDeploymentSlot

public abstract class FunctionAppBase<T extends FunctionAppBase<T,P,F>,P extends com.microsoft.azure.toolkit.lib.common.model.AbstractAzResource<P,?,?>,F extends com.azure.resourcemanager.appservice.models.WebAppBase>
extends AppServiceAppBase<T,P,F>

Nested Class Summary

Nested classes/interfaces inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzResource

com.microsoft.azure.toolkit.lib.common.model.AzResource.Draft<T extends com.microsoft.azure.toolkit.lib.common.model.AzResource,R extends Object>, com.microsoft.azure.toolkit.lib.common.model.AzResource.None, com.microsoft.azure.toolkit.lib.common.model.AzResource.Status

Nested classes/interfaces inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzResourceBase

com.microsoft.azure.toolkit.lib.common.model.AzResourceBase.FormalStatus

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_REMOTE_DEBUG_JAVA_OPTS
static String	DEFAULT_REMOTE_DEBUG_PORT
private AzureFunctionsAdminClient	fileClient
private static String	FUNCTION_DEPLOY_TYPE
static String	HTTP_PLATFORM_DEBUG_PORT
private Boolean	isEnableRemoteDebugging
static String	JAVA_OPTS
static String	PREFER_IPV_4_STACK_TRUE
static String	XDEBUG
static String	XRUNJDWP

Fields inherited from class com.microsoft.azure.toolkit.lib.appservice.AppServiceAppBase

kuduManager

Fields inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzResource

CACHE_LIFETIME, NONE, RESOURCE_GROUP_PLACEHOLDER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FunctionAppBase(String name, com.microsoft.azure.toolkit.lib.common.model.AbstractAzResourceModule<T,P,com.azure.resourcemanager.appservice.models.WebSiteBase> module)
protected	FunctionAppBase(String name, String resourceGroupName, com.microsoft.azure.toolkit.lib.common.model.AbstractAzResourceModule<T,P,com.azure.resourcemanager.appservice.models.WebSiteBase> module)
protected	FunctionAppBase(T origin)

Method Summary

Modifier and Type	Method	Description
void	deploy(File targetFile)
void	deploy(File targetFile, FunctionDeployType functionDeployType)
abstract void	disableRemoteDebug()
abstract void	enableRemoteDebug()
protected AzureFunctionsAdminClient	getAdminClient()
protected FunctionDeployType	getDefaultDeployType()
protected IFunctionDeployHandler	getDeployHandlerByType(FunctionDeployType deployType)
protected IFileClient	getFileClient()
private boolean	getIsRemoteDebuggingEnabled()
String	getJavaOptsWithRemoteDebugDisabled(Map<String,String> appSettings)
String	getJavaOptsWithRemoteDebugEnabled(Map<String,String> appSettings, String debugPort)
abstract String	getMasterKey()
protected String	getRemoteDebugPort()
boolean	isRemoteDebugEnabled()
void	ping()
protected void	updateAdditionalProperties(com.azure.resourcemanager.appservice.models.WebSiteBase newRemote, com.azure.resourcemanager.appservice.models.WebSiteBase oldRemote)

Methods inherited from class com.microsoft.azure.toolkit.lib.appservice.AppServiceAppBase

createDirectory, deleteFile, execute, getAppServicePlan, getAppServiceTunnelStatus, getAppSettings, getDiagnosticConfig, getFileByPath, getFileContent, getFilesInDirectory, getFullRemote, getHostName, getKuduHostName, getKuduManager, getLinuxFxVersion, getProcessClient, getPublishingProfile, getRegion, getRuntime, listProcess, listPublishingProfileXmlWithSecrets, loadStatus, refreshRemoteFromAzure, restart, start, stop, streamAllLogsAsync, uploadFileToPath

Methods inherited from class com.microsoft.azure.toolkit.lib.common.model.AbstractAzResource

canEqual, delete, deleteFromCache, doModify, doModify, equals, exists, getId, getModule, getName, getParent, getRemote, getResourceGroup, getResourceGroupName, getStatus, getSubModule, getSubModules, hashCode, invalidateCache, isDraft, isDraftForCreating, isDraftForUpdating, loadRemote, refresh, reloadStatus, remoteOptional, setRemote, setStatus, toString, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzResource

getFullResourceType, getPortalUrl, getResourceTypeName, getSubscription, getSubscriptionId, id, name

Methods inherited from interface com.microsoft.azure.toolkit.lib.common.model.AzResourceBase

getFormalStatus

Methods inherited from interface com.microsoft.azure.toolkit.lib.common.model.Deletable

delete

Methods inherited from interface com.microsoft.azure.toolkit.lib.common.model.Startable

isRestartable, isStartable, isStoppable

Field Detail

FUNCTION_DEPLOY_TYPE

private static final String FUNCTION_DEPLOY_TYPE

See Also:

Constant Field Values

JAVA_OPTS

public static final String JAVA_OPTS

See Also:

Constant Field Values

HTTP_PLATFORM_DEBUG_PORT

public static final String HTTP_PLATFORM_DEBUG_PORT

See Also:

Constant Field Values

PREFER_IPV_4_STACK_TRUE

public static final String PREFER_IPV_4_STACK_TRUE

See Also:

Constant Field Values

XDEBUG

public static final String XDEBUG

See Also:

Constant Field Values

XRUNJDWP

public static final String XRUNJDWP

See Also:

Constant Field Values

DEFAULT_REMOTE_DEBUG_PORT

public static final String DEFAULT_REMOTE_DEBUG_PORT

See Also:

Constant Field Values

DEFAULT_REMOTE_DEBUG_JAVA_OPTS

public static final String DEFAULT_REMOTE_DEBUG_JAVA_OPTS

See Also:

Constant Field Values

isEnableRemoteDebugging

private Boolean isEnableRemoteDebugging

fileClient

private AzureFunctionsAdminClient fileClient

Constructor Detail

FunctionAppBase

protected FunctionAppBase(@Nonnull
                          String name,
                          @Nonnull
                          String resourceGroupName,
                          @Nonnull
                          com.microsoft.azure.toolkit.lib.common.model.AbstractAzResourceModule<T,P,com.azure.resourcemanager.appservice.models.WebSiteBase> module)

FunctionAppBase

protected FunctionAppBase(@Nonnull
                          String name,
                          @Nonnull
                          com.microsoft.azure.toolkit.lib.common.model.AbstractAzResourceModule<T,P,com.azure.resourcemanager.appservice.models.WebSiteBase> module)

FunctionAppBase

protected FunctionAppBase(@Nonnull
                          T origin)

Method Detail

deploy

public void deploy(File targetFile)

deploy

public void deploy(File targetFile,
                   FunctionDeployType functionDeployType)

getAdminClient

protected AzureFunctionsAdminClient getAdminClient()

getFileClient

@Nullable
protected IFileClient getFileClient()

Overrides:

getFileClient in class AppServiceAppBase<T extends FunctionAppBase<T,P,F>,P extends com.microsoft.azure.toolkit.lib.common.model.AbstractAzResource<P,?,?>,F extends com.azure.resourcemanager.appservice.models.WebAppBase>

getDefaultDeployType

protected FunctionDeployType getDefaultDeployType()

getDeployHandlerByType

protected IFunctionDeployHandler getDeployHandlerByType(FunctionDeployType deployType)

getMasterKey

public abstract String getMasterKey()

isRemoteDebugEnabled

public boolean isRemoteDebugEnabled()

enableRemoteDebug

public abstract void enableRemoteDebug()

disableRemoteDebug

public abstract void disableRemoteDebug()

ping

public void ping()

getRemoteDebugPort

protected String getRemoteDebugPort()

getJavaOptsWithRemoteDebugDisabled

public String getJavaOptsWithRemoteDebugDisabled(Map<String,String> appSettings)

getJavaOptsWithRemoteDebugEnabled

public String getJavaOptsWithRemoteDebugEnabled(Map<String,String> appSettings,
                                                String debugPort)

updateAdditionalProperties

protected void updateAdditionalProperties(@Nullable
                                          com.azure.resourcemanager.appservice.models.WebSiteBase newRemote,
                                          @Nullable
                                          com.azure.resourcemanager.appservice.models.WebSiteBase oldRemote)

Overrides:

updateAdditionalProperties in class com.microsoft.azure.toolkit.lib.common.model.AbstractAzResource<T extends FunctionAppBase<T,P,F>,P extends com.microsoft.azure.toolkit.lib.common.model.AbstractAzResource<P,?,?>,com.azure.resourcemanager.appservice.models.WebSiteBase>

getIsRemoteDebuggingEnabled

private boolean getIsRemoteDebuggingEnabled()