com.microsoft.azure.maven.function

Class AbstractFunctionMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.AbstractAppServiceMojo

com.microsoft.azure.maven.function.AbstractFunctionMojo

All Implemented Interfaces:

AuthConfiguration, TelemetryConfiguration, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AddMojo, DeployMojo, ListMojo, PackageMojo, RunMojo

public abstract class AbstractFunctionMojo
extends AbstractAppServiceMojo

Nested Class Summary

Nested classes/interfaces inherited from class com.microsoft.azure.maven.AbstractAzureMojo

AbstractAzureMojo.DefaultUncaughtExceptionHandler, AbstractAzureMojo.RunnableWithException

Field Summary

Fields

Modifier and Type	Field and Description
protected String	appInsightsInstance
protected String	appInsightsKey
private static String	CHANGE_FUNCTIONS_WORKER_RUNTIME
private static String	DISABLE_APP_INSIGHTS_KEY
protected boolean	disableAppInsights
protected String	finalName
private static String	FUNCTION_JAVA_VERSION_KEY
private static String	FUNCTIONS_EXTENSION_VERSION_NAME
private static String	FUNCTIONS_EXTENSION_VERSION_VALUE
private static String	FUNCTIONS_WORKER_RUNTIME_NAME
private static String	FUNCTIONS_WORKER_RUNTIME_VALUE
protected File	outputDirectory
protected String	pricingTier App Service pricing tier, which will only be used to create Functions App at the first time. Below is the list of supported pricing tier: F1 D1 B1 B2 B3 S1 S2 S3 P1V2 P2V2 P3V2
protected String	region App Service region, which will only be used to create App Service at the first time.
protected RuntimeConfiguration	runtime
private static String	SET_FUNCTIONS_EXTENSION_VERSION
private static String	SET_FUNCTIONS_WORKER_RUNTIME
protected boolean	skip Skip execution.

Fields inherited from class com.microsoft.azure.maven.AbstractAppServiceMojo

appName, appServicePlanName, appServicePlanResourceGroup, appSettings, deploymentSlotSetting, deploymentType, MAVEN_PLUGIN_POSTFIX, PORTAL_URL_PATTERN, resourceGroup

Fields inherited from class com.microsoft.azure.maven.AbstractAzureMojo

allowTelemetry, auth, authentication, authType, buildDirectory, DEPLOY, failsOnError, httpProxyHost, httpProxyPort, INSTALLATION_ID_KEY, mavenResourcesFiltering, plugin, PLUGIN_NAME_KEY, PLUGIN_VERSION_KEY, project, session, SESSION_ID_KEY, settings, settingsDecrypter, SUBSCRIPTION_ID_KEY, subscriptionId

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractFunctionMojo()

Method Summary

Modifier and Type	Method and Description
String	getAppInsightsInstance()
String	getAppInsightsKey()
Map	getAppSettingsWithDefaultValue()
String	getFinalName()
com.microsoft.azure.management.appservice.FunctionApp	getFunctionApp()
FunctionExtensionVersion	getFunctionExtensionVersion()
com.microsoft.azure.management.appservice.PricingTier	getPricingTier()
String	getRegion()
RuntimeConfiguration	getRuntime()
Map<String,String>	getTelemetryProperties()
boolean	isDisableAppInsights()
protected boolean	isSkipMojo()
private void	overrideDefaultAppSetting(Map result, String settingName, String settingIsEmptyMessage, String settingValue, String changeSettingMessage)
private void	setDefaultAppSetting(Map result, String settingName, String settingIsEmptyMessage, String settingValue)

Methods inherited from class com.microsoft.azure.maven.AbstractAppServiceMojo

getAppName, getAppServicePlanName, getAppServicePlanResourceGroup, getAppSettings, getDeploymentSlotSetting, getDeploymentStagingDirectoryPath, getDeploymentType, getResourceGroup, getResourcePortalUrl, getResources, setDeploymentSlot

Methods inherited from class com.microsoft.azure.maven.AbstractAzureMojo

doExecute, execute, executeWithTimeRecorder, getAuthenticationSetting, getAuthMethod, getAuthTypeEnum, getAzureClient, getAzureClientByAuthType, getAzureTokenWrapper, getBuildDirectoryAbsolutePath, getHttpProxyHost, getHttpProxyPort, getInstallationId, getMavenResourcesFiltering, getPluginName, getPluginVersion, getProject, getSession, getSessionId, getSettings, getSubscriptionId, getTelemetryProxy, getUserAgent, handleException, infoWithMultipleLines, initAuth, initializeAuthConfiguration, initTelemetry, isAuthConfigurationExist, isFailingOnError, isTelemetryAllowed, printCurrentSubscription, trackMojoFailure, trackMojoSkip, trackMojoStart, trackMojoSuccess

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FUNCTIONS_WORKER_RUNTIME_NAME

private static final String FUNCTIONS_WORKER_RUNTIME_NAME

See Also:

Constant Field Values

FUNCTIONS_WORKER_RUNTIME_VALUE

private static final String FUNCTIONS_WORKER_RUNTIME_VALUE

See Also:

Constant Field Values

SET_FUNCTIONS_WORKER_RUNTIME

private static final String SET_FUNCTIONS_WORKER_RUNTIME

See Also:

Constant Field Values

CHANGE_FUNCTIONS_WORKER_RUNTIME

private static final String CHANGE_FUNCTIONS_WORKER_RUNTIME

See Also:

Constant Field Values

FUNCTIONS_EXTENSION_VERSION_NAME

private static final String FUNCTIONS_EXTENSION_VERSION_NAME

See Also:

Constant Field Values

FUNCTIONS_EXTENSION_VERSION_VALUE

private static final String FUNCTIONS_EXTENSION_VERSION_VALUE

See Also:

Constant Field Values

SET_FUNCTIONS_EXTENSION_VERSION

private static final String SET_FUNCTIONS_EXTENSION_VERSION

See Also:

Constant Field Values

FUNCTION_JAVA_VERSION_KEY

private static final String FUNCTION_JAVA_VERSION_KEY

See Also:

Constant Field Values

DISABLE_APP_INSIGHTS_KEY

private static final String DISABLE_APP_INSIGHTS_KEY

See Also:

Constant Field Values

pricingTier

@Parameter(property="functions.pricingTier")
protected String pricingTier

App Service pricing tier, which will only be used to create Functions App at the first time.
Below is the list of supported pricing tier:

• F1
• D1
• B1
• B2
• B3
• S1
• S2
• S3
• P1V2
• P2V2
• P3V2

finalName

@Parameter(defaultValue="${project.build.finalName}",
           readonly=true,
           required=true)
protected String finalName

outputDirectory

@Parameter(defaultValue="${project.build.outputDirectory}",
           readonly=true,
           required=true)
protected File outputDirectory

skip

@Parameter(property="functions.skip",
           defaultValue="false")
protected boolean skip

Skip execution.

Since:

0.1.0

region

@Parameter(property="functions.region",
           defaultValue="westeurope")
protected String region

App Service region, which will only be used to create App Service at the first time.

runtime

@Parameter(property="functions.runtime")
protected RuntimeConfiguration runtime

appInsightsInstance

@Parameter(property="functions.appInsightsInstance")
protected String appInsightsInstance

appInsightsKey

@Parameter(property="functions.appInsightsKey")
protected String appInsightsKey

disableAppInsights

@Parameter(property="functions.disableAppInsights",
           defaultValue="false")
protected boolean disableAppInsights

Constructor Detail

AbstractFunctionMojo

public AbstractFunctionMojo()

Method Detail

getAppSettingsWithDefaultValue

public Map getAppSettingsWithDefaultValue()

getFunctionExtensionVersion

public FunctionExtensionVersion getFunctionExtensionVersion()
                                                     throws AzureExecutionException

Throws:

AzureExecutionException

overrideDefaultAppSetting

private void overrideDefaultAppSetting(Map result,
                                       String settingName,
                                       String settingIsEmptyMessage,
                                       String settingValue,
                                       String changeSettingMessage)

setDefaultAppSetting

private void setDefaultAppSetting(Map result,
                                  String settingName,
                                  String settingIsEmptyMessage,
                                  String settingValue)

getPricingTier

public com.microsoft.azure.management.appservice.PricingTier getPricingTier()
                                                                     throws AzureExecutionException

Throws:

AzureExecutionException

getRegion

public String getRegion()

isSkipMojo

protected boolean isSkipMojo()

Overrides:

isSkipMojo in class AbstractAzureMojo

getFinalName

public String getFinalName()

getAppInsightsInstance

public String getAppInsightsInstance()

getAppInsightsKey

public String getAppInsightsKey()

isDisableAppInsights

public boolean isDisableAppInsights()

getFunctionApp

@Nullable
public com.microsoft.azure.management.appservice.FunctionApp getFunctionApp()
                                                                                throws AzureAuthFailureException

Throws:

AzureAuthFailureException

getRuntime

public RuntimeConfiguration getRuntime()

getTelemetryProperties

public Map<String,String> getTelemetryProperties()

Specified by:

getTelemetryProperties in interface TelemetryConfiguration

Overrides:

getTelemetryProperties in class AbstractAzureMojo