com.microsoft.azure.maven.function

Class AbstractFunctionMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.appservice.AbstractAppServiceMojo

com.microsoft.azure.maven.function.AbstractFunctionMojo

All Implemented Interfaces:

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 Integer	alwaysReadyInstances
protected String	appInsightsInstance Name of the application insight instance, must be in the same resource group with function app.
protected String	appInsightsKey Instrumentation key of the application insights instance
protected String	artifactPath Path for the artifact to package and deploy
protected static String	AZURE_FUNCTIONS_JAVA_LIBRARY
protected static String	CAN_NOT_FIND_ARTIFACT
private static String	DISABLE_APP_INSIGHTS_KEY
protected Boolean	disableAppInsights Boolean flag to monitor the Function App with application insights
protected Boolean	enableDistributedTracing Boolean flag to control whether to enable distributed tracing for function app
protected String	environment Name of the container app environment.
protected String	finalName
private static String	FUNCTION_DEPLOY_TO_SLOT_KEY
protected static Map<FunctionExtensionVersion,Set<Integer>>	FUNCTION_EXTENSION_LIBRARY_MAP
private static String	FUNCTION_IS_DOCKER_KEY
private static String	FUNCTION_JAVA_VERSION_KEY
private static String	FUNCTION_PRICING_KEY
private static String	FUNCTION_REGION_KEY
private static String	FUNCTION_RUNTIME_KEY
protected static String	HOST_JSON
protected String	hostJson Path for host.json file
protected Integer	instanceSize
protected static String	LOCAL_SETTINGS_JSON
protected String	localSettingsJson Path for local.settings.json file
protected Integer	maximumInstances
protected Integer	maxReplicas The maximum number of replicas when create function app on container app.
protected Integer	minReplicas The minimum number of replicas when create function app on container app.
protected File	outputDirectory
protected ConfigParser	parser
protected String	pricingTier Pricing for function app
protected String	region Region for function app Supported values: westus, westus2, eastus, eastus2, northcentralus, southcentralus, westcentralus, canadacentral, canadaeast, brazilsouth, northeurope, westeurope, uksouth, eastasia, southeastasia, japaneast, japanwest, australiaeast, australiasoutheast, centralindia, southindia ...
protected RuntimeConfiguration	runtime Runtime environment of function app
protected Boolean	skip Boolean flag to skip the execution of maven plugin for azure functions
protected String	storageAccountName Name of the storage account.
protected String	storageAccountResourceGroup Resource group of storage account.
protected static String	TRIGGER_TYPE

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

appName, appServiceClient, appServicePlanName, appServicePlanResourceGroup, appSettings, deploymentSlotSetting, MAVEN_PLUGIN_POSTFIX, resourceGroup

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

allowTelemetry, auth, authType, buildDirectory, COMPILE_LEVEL_NOT_SUPPORTED, FAILED_TO_GET_VALID_RUNTIMES, failsOnError, failsOnRuntimeValidationError, INSTALLATION_ID_KEY, mavenResourcesFiltering, plugin, PLUGIN_NAME_KEY, PLUGIN_VERSION_KEY, project, session, SESSION_ID_KEY, settings, settingsDecrypter, SUBSCRIPTION_ID_KEY, SUBSCRIPTION_NOT_FOUND, SUBSCRIPTION_TEMPLATE, subscriptionId, telemetries, telemetryProxy, USING_AZURE_ENVIRONMENT

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()
protected File	getArtifact()
protected FunctionExtensionVersion	getBundleVersion()
String	getFinalName()
protected String	getFunctionLibraryVersion()
protected File	getHostJsonFile()
protected File	getLocalSettingsJsonFile()
String	getRegion()
RuntimeConfiguration	getRuntimeConfiguration()
Map<String,String>	getTelemetryProperties()
boolean	isDisableAppInsights()
protected boolean	isSkipMojo()
protected com.fasterxml.jackson.databind.JsonNode	readHostJson()
protected void	validateAppName()
protected void	validateFunctionCompatibility()

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

getAppName, getAppServicePlanName, getAppServicePlanResourceGroup, getAppSettings, getDeploymentSlotSetting, getDeploymentStagingDirectoryPath, getResourceGroup, getResources, initAzureAppServiceClient, printCurrentSubscription

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

afterMojoExecution, beforeMojoExecution, checkSubscription, doExecute, execute, executeWithTimeRecorder, getActualAuthType, getAllowTelemetry, getBuildDirectoryAbsolutePath, getCompileLevel, getFailsOnError, getFailsOnRuntimeValidationError, getInstallationId, getMavenResourcesFiltering, getPluginName, getPluginVersion, getProject, getSession, getSessionId, getSettings, getSubscriptionId, getTargetSubscriptionId, getTelemetries, getTelemetryProxy, getUserAgent, getValidRuntimes, highlightDefaultValue, infoWithMultipleLines, initTelemetryProxy, loginAzure, loginAzure, onMojoError, onSkipped, printCredentialDescription, selectSubscription, selectSubscription, trackMojoFailure, updateTelemetryProperties, validateArtifactCompileVersion

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

HOST_JSON

protected static final String HOST_JSON

See Also:

Constant Field Values

LOCAL_SETTINGS_JSON

protected static final String LOCAL_SETTINGS_JSON

See Also:

Constant Field Values

TRIGGER_TYPE

protected static final String TRIGGER_TYPE

See Also:

Constant Field Values

AZURE_FUNCTIONS_JAVA_LIBRARY

protected static final String AZURE_FUNCTIONS_JAVA_LIBRARY

See Also:

Constant Field Values

CAN_NOT_FIND_ARTIFACT

protected static final String CAN_NOT_FIND_ARTIFACT

See Also:

Constant Field Values

FUNCTION_EXTENSION_LIBRARY_MAP

protected static final Map<FunctionExtensionVersion,Set<Integer>> FUNCTION_EXTENSION_LIBRARY_MAP

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

FUNCTION_RUNTIME_KEY

private static final String FUNCTION_RUNTIME_KEY

See Also:

Constant Field Values

FUNCTION_IS_DOCKER_KEY

private static final String FUNCTION_IS_DOCKER_KEY

See Also:

Constant Field Values

FUNCTION_REGION_KEY

private static final String FUNCTION_REGION_KEY

See Also:

Constant Field Values

FUNCTION_PRICING_KEY

private static final String FUNCTION_PRICING_KEY

See Also:

Constant Field Values

FUNCTION_DEPLOY_TO_SLOT_KEY

private static final String FUNCTION_DEPLOY_TO_SLOT_KEY

See Also:

Constant Field Values

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

pricingTier

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

Pricing for function app

Supported values : CONSUMPTION, B1, B2, B3, S1, S2, S3, P1V2, P2V2, P3V2, P1V3, P2V3, P3V3, EP1, EP2, EP3

skip

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

Boolean flag to skip the execution of maven plugin for azure functions

Since:

0.1.0

region

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

Region for function app Supported values: westus, westus2, eastus, eastus2, northcentralus, southcentralus, westcentralus, canadacentral, canadaeast, brazilsouth, northeurope, westeurope, uksouth, eastasia, southeastasia, japaneast, japanwest, australiaeast, australiasoutheast, centralindia, southindia ...

Since:

1.2.0

runtime

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

Runtime environment of function app

Properties for Windows/Linux function app

• os: Operating system for the function App, default to be Windows.
• javaVersion: Java runtime version the function App, supported values are `Java 8`, `Java 11` and `Java 17`, default to be `Java 17`.

 
 <runtime>
     <os>windows</os>
     <javaVersion>Java 17</javaVersion>
 </runtime>
 
 

Properties for Docker function app

• image: Name of the docker image to deploy.
• registryUrl: Docker repository of the image, could be omitted for docker hub.
• serverId: The authentication profile id in maven settings.xml. For private docker image, please set your username and password in maven settings.xml and refer it with `serverId` in runtime configuration.

 
 <runtime>
     <os>docker</os>
     <image>[hub-user/]repo-name[:tag]</image>
     <serverId></serverId>
     <registryUrl></registryUrl> <!- could be omitted for docker hub images -->
 </runtime>
 
 

Since:

1.4.0

appInsightsInstance

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

Name of the application insight instance, must be in the same resource group with function app. Will be skipped if `appInsightsKey` is specified

Since:

1.6.0

appInsightsKey

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

Instrumentation key of the application insights instance

Since:

1.6.0

disableAppInsights

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

Boolean flag to monitor the Function App with application insights

Since:

1.6.0

enableDistributedTracing

@Parameter(property="functions.enableDistributedTracing")
protected Boolean enableDistributedTracing

Boolean flag to control whether to enable distributed tracing for function app

hostJson

@Parameter(property="functions.hostJson",
           defaultValue="host.json")
protected String hostJson

Path for host.json file

Since:

1.22.0

localSettingsJson

@Parameter(property="functions.localSettingsJson",
           defaultValue="local.settings.json")
protected String localSettingsJson

Path for local.settings.json file

Since:

1.22.0

artifactPath

@Parameter(property="functions.artifact")
protected String artifactPath

Path for the artifact to package and deploy

alwaysReadyInstances

@Parameter
protected Integer alwaysReadyInstances

instanceSize

@Parameter
protected Integer instanceSize

maximumInstances

@Parameter
protected Integer maximumInstances

storageAccountName

@Parameter
protected String storageAccountName

Name of the storage account. It will be created if it doesn't exist.

storageAccountResourceGroup

@Parameter
protected String storageAccountResourceGroup

Resource group of storage account. It will be created if it doesn't exist.

environment

@Parameter
protected String environment

Name of the container app environment. It will be created if it doesn't exist.

minReplicas

@Parameter
protected Integer minReplicas

The minimum number of replicas when create function app on container app.

maxReplicas

@Parameter
protected Integer maxReplicas

The maximum number of replicas when create function app on container app.

parser

protected final ConfigParser parser

Constructor Detail

AbstractFunctionMojo

public AbstractFunctionMojo()

Method Detail

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()

getRuntimeConfiguration

public RuntimeConfiguration getRuntimeConfiguration()

getArtifact

@Nonnull
protected File getArtifact()
                              throws com.microsoft.azure.toolkit.lib.common.exception.AzureToolkitRuntimeException

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureToolkitRuntimeException

getHostJsonFile

protected File getHostJsonFile()

getLocalSettingsJsonFile

protected File getLocalSettingsJsonFile()

validateAppName

protected void validateAppName()

validateFunctionCompatibility

protected void validateFunctionCompatibility()

getFunctionLibraryVersion

@Nullable
protected String getFunctionLibraryVersion()

readHostJson

@Nullable
protected com.fasterxml.jackson.databind.JsonNode readHostJson()

getBundleVersion

@Nullable
protected FunctionExtensionVersion getBundleVersion()

getTelemetryProperties

public Map<String,String> getTelemetryProperties()

Overrides:

getTelemetryProperties in class AbstractAzureMojo