com.microsoft.azure.maven.function

Class DeployMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.AbstractAppServiceMojo

com.microsoft.azure.maven.function.AbstractFunctionMojo

com.microsoft.azure.maven.function.DeployMojo

All Implemented Interfaces:

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

@Mojo(name="deploy",
      defaultPhase=DEPLOY)
public class DeployMojo
extends AbstractFunctionMojo

Deploy artifacts to target Azure Functions in Azure. If target Azure Functions doesn't exist, it will be created.

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
private static String	APPINSIGHTS_INSTRUMENTATION_KEY
private static String	APPLICATION_INSIGHTS_CONFIGURATION_CONFLICT
private static String	APPLICATION_INSIGHTS_CREATE_FAILED
private static String	APPLICATION_INSIGHTS_CREATE_START
private static String	APPLICATION_INSIGHTS_CREATED
private static String	APPLICATION_INSIGHTS_NOT_SUPPORTED
private static String	ARTIFACT_INCOMPATIBLE
private static String	AUTH_LEVEL
private static String	DEPLOY_FINISH
private static String	DEPLOY_START
private static String	DEPLOYMENT_TYPE_KEY
private static String	FAILED_TO_GET_APPLICATION_INSIGHTS
private static String	FAILED_TO_GET_FUNCTION_APP_PRICING_TIER
private static String	FAILED_TO_LIST_TRIGGERS
private static String	FUNCTION_APP_CREATE_START
private static String	FUNCTION_APP_CREATED
private static String	FUNCTION_APP_NOT_EXISTS
private static String	FUNCTION_APP_UPDATE
private static String	FUNCTION_APP_UPDATE_DONE
private static String	FUNCTION_SLOT_CREATE_START
private static String	FUNCTION_SLOT_CREATED
private static String	FUNCTION_SLOT_UPDATE
private static String	FUNCTION_SLOT_UPDATE_DONE
private static String	HTTP_TRIGGER
private static String	HTTP_TRIGGER_URLS
private static String	INSTRUMENTATION_KEY_IS_NOT_VALID
private static int	LIST_TRIGGERS_MAX_RETRY
private static int	LIST_TRIGGERS_RETRY_PERIOD_IN_SECONDS
private static String	NO_ANONYMOUS_HTTP_TRIGGER
private static String	NO_TRIGGERS_FOUNDED
private com.microsoft.azure.management.appservice.JavaVersion	parsedJavaVersion
private static String	SKIP_CREATING_APPLICATION_INSIGHTS
private static String	SYNCING_TRIGGERS_AND_FETCH_FUNCTION_INFORMATION
private static String	UNABLE_TO_LIST_NONE_ANONYMOUS_HTTP_TRIGGERS
private static String	UNKNOWN_DEPLOYMENT_TYPE

Fields inherited from class com.microsoft.azure.maven.function.AbstractFunctionMojo

appInsightsInstance, appInsightsKey, disableAppInsights, finalName, outputDirectory, pricingTier, region, runtime, skip

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

Method Summary

Modifier and Type	Method and Description
private void	bindApplicationInsights(Map appSettings, boolean isCreation) Binding Function App with Application Insights Will follow the below sequence appInsightsKey -> appInsightsInstance -> Create New AI Instance (Function creation only)
protected void	checkArtifactCompileVersion()
protected void	configureAppSettings(java.util.function.Consumer<Map> withAppSettings, Map appSettings)
private com.microsoft.azure.management.applicationinsights.v2015_05_01.ApplicationInsightsComponent	createApplicationInsights(ApplicationInsightsManager applicationInsightsManager, String name)
protected com.microsoft.azure.management.appservice.FunctionDeploymentSlot	createDeploymentSlot(com.microsoft.azure.management.appservice.FunctionApp functionApp, FunctionRuntimeHandler runtimeHandler)
protected com.microsoft.azure.management.appservice.FunctionApp	createFunctionApp(FunctionRuntimeHandler runtimeHandler)
protected com.microsoft.azure.management.appservice.WebAppBase	createOrUpdateResource()
private void	deployArtifact(DeployTarget deployTarget)
protected void	doExecute()
private com.microsoft.azure.management.applicationinsights.v2015_05_01.ApplicationInsightsComponent	getApplicationInsights(ApplicationInsightsManager applicationInsightsManager, String appInsightsInstance)
protected ArtifactHandler	getArtifactHandler()
private File	getArtifactToDeploy()
DeploymentType	getDeploymentType()
protected DeploymentType	getDeploymentTypeByRuntime()
protected FunctionRuntimeHandler	getFunctionRuntimeHandler()
private com.microsoft.azure.management.applicationinsights.v2015_05_01.ApplicationInsightsComponent	getOrCreateApplicationInsights(boolean enableCreation)
protected OperatingSystemEnum	getOsEnum()
protected boolean	isDedicatedPricingTier()
private boolean	isDeployToSlot()
private List<FunctionResource>	listFunctions() Sync triggers and return function list of deployed function app Will retry when get empty result, the max retry times is LIST_TRIGGERS_MAX_RETRY
protected void	listHTTPTriggerUrls() List anonymous HTTP Triggers url after deployment
protected void	parseConfiguration()
protected com.microsoft.azure.management.appservice.FunctionDeploymentSlot	updateDeploymentSlot(com.microsoft.azure.management.appservice.FunctionDeploymentSlot deploymentSlot, FunctionRuntimeHandler runtimeHandler)
protected com.microsoft.azure.management.appservice.FunctionApp	updateFunctionApp(com.microsoft.azure.management.appservice.FunctionApp app, FunctionRuntimeHandler runtimeHandler)
private com.microsoft.azure.management.appservice.WebAppBase.Update	updateFunctionAppSettings(com.microsoft.azure.management.appservice.WebAppBase.Update update)
private void	validateApplicationInsightsConfiguration()

Methods inherited from class com.microsoft.azure.maven.function.AbstractFunctionMojo

getAppInsightsInstance, getAppInsightsKey, getAppSettingsWithDefaultValue, getFinalName, getFunctionApp, getFunctionExtensionVersion, getPricingTier, getRegion, getRuntime, getTelemetryProperties, isDisableAppInsights, isSkipMojo

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

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

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

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

LIST_TRIGGERS_MAX_RETRY

private static final int LIST_TRIGGERS_MAX_RETRY

See Also:

Constant Field Values

LIST_TRIGGERS_RETRY_PERIOD_IN_SECONDS

private static final int LIST_TRIGGERS_RETRY_PERIOD_IN_SECONDS

See Also:

Constant Field Values

DEPLOY_START

private static final String DEPLOY_START

See Also:

Constant Field Values

DEPLOY_FINISH

private static final String DEPLOY_FINISH

See Also:

Constant Field Values

FUNCTION_APP_CREATE_START

private static final String FUNCTION_APP_CREATE_START

See Also:

Constant Field Values

FUNCTION_APP_CREATED

private static final String FUNCTION_APP_CREATED

See Also:

Constant Field Values

FUNCTION_SLOT_CREATE_START

private static final String FUNCTION_SLOT_CREATE_START

See Also:

Constant Field Values

FUNCTION_SLOT_CREATED

private static final String FUNCTION_SLOT_CREATED

See Also:

Constant Field Values

FUNCTION_APP_UPDATE

private static final String FUNCTION_APP_UPDATE

See Also:

Constant Field Values

FUNCTION_APP_UPDATE_DONE

private static final String FUNCTION_APP_UPDATE_DONE

See Also:

Constant Field Values

FUNCTION_SLOT_UPDATE

private static final String FUNCTION_SLOT_UPDATE

See Also:

Constant Field Values

FUNCTION_SLOT_UPDATE_DONE

private static final String FUNCTION_SLOT_UPDATE_DONE

See Also:

Constant Field Values

DEPLOYMENT_TYPE_KEY

private static final String DEPLOYMENT_TYPE_KEY

See Also:

Constant Field Values

UNKNOWN_DEPLOYMENT_TYPE

private static final String UNKNOWN_DEPLOYMENT_TYPE

See Also:

Constant Field Values

APPINSIGHTS_INSTRUMENTATION_KEY

private static final String APPINSIGHTS_INSTRUMENTATION_KEY

See Also:

Constant Field Values

APPLICATION_INSIGHTS_NOT_SUPPORTED

private static final String APPLICATION_INSIGHTS_NOT_SUPPORTED

See Also:

Constant Field Values

APPLICATION_INSIGHTS_CONFIGURATION_CONFLICT

private static final String APPLICATION_INSIGHTS_CONFIGURATION_CONFLICT

See Also:

Constant Field Values

FAILED_TO_GET_APPLICATION_INSIGHTS

private static final String FAILED_TO_GET_APPLICATION_INSIGHTS

See Also:

Constant Field Values

SKIP_CREATING_APPLICATION_INSIGHTS

private static final String SKIP_CREATING_APPLICATION_INSIGHTS

See Also:

Constant Field Values

APPLICATION_INSIGHTS_CREATE_START

private static final String APPLICATION_INSIGHTS_CREATE_START

See Also:

Constant Field Values

APPLICATION_INSIGHTS_CREATED

private static final String APPLICATION_INSIGHTS_CREATED

See Also:

Constant Field Values

APPLICATION_INSIGHTS_CREATE_FAILED

private static final String APPLICATION_INSIGHTS_CREATE_FAILED

See Also:

Constant Field Values

INSTRUMENTATION_KEY_IS_NOT_VALID

private static final String INSTRUMENTATION_KEY_IS_NOT_VALID

See Also:

Constant Field Values

FAILED_TO_GET_FUNCTION_APP_PRICING_TIER

private static final String FAILED_TO_GET_FUNCTION_APP_PRICING_TIER

See Also:

Constant Field Values

FAILED_TO_LIST_TRIGGERS

private static final String FAILED_TO_LIST_TRIGGERS

See Also:

Constant Field Values

UNABLE_TO_LIST_NONE_ANONYMOUS_HTTP_TRIGGERS

private static final String UNABLE_TO_LIST_NONE_ANONYMOUS_HTTP_TRIGGERS

See Also:

Constant Field Values

HTTP_TRIGGER_URLS

private static final String HTTP_TRIGGER_URLS

See Also:

Constant Field Values

NO_ANONYMOUS_HTTP_TRIGGER

private static final String NO_ANONYMOUS_HTTP_TRIGGER

See Also:

Constant Field Values

AUTH_LEVEL

private static final String AUTH_LEVEL

See Also:

Constant Field Values

HTTP_TRIGGER

private static final String HTTP_TRIGGER

See Also:

Constant Field Values

NO_TRIGGERS_FOUNDED

private static final String NO_TRIGGERS_FOUNDED

See Also:

Constant Field Values

SYNCING_TRIGGERS_AND_FETCH_FUNCTION_INFORMATION

private static final String SYNCING_TRIGGERS_AND_FETCH_FUNCTION_INFORMATION

See Also:

Constant Field Values

ARTIFACT_INCOMPATIBLE

private static final String ARTIFACT_INCOMPATIBLE

See Also:

Constant Field Values

FUNCTION_APP_NOT_EXISTS

private static final String FUNCTION_APP_NOT_EXISTS

See Also:

Constant Field Values

parsedJavaVersion

private com.microsoft.azure.management.appservice.JavaVersion parsedJavaVersion

Constructor Detail

DeployMojo

public DeployMojo()

Method Detail

getDeploymentType

public DeploymentType getDeploymentType()
                                 throws AzureExecutionException

Overrides:

getDeploymentType in class AbstractAppServiceMojo

Throws:

AzureExecutionException

doExecute

protected void doExecute()
                  throws AzureExecutionException

Specified by:

doExecute in class AbstractAzureMojo

Throws:

AzureExecutionException

deployArtifact

private void deployArtifact(DeployTarget deployTarget)
                     throws AzureExecutionException,
                            AzureAuthFailureException

Throws:

AzureExecutionException

AzureAuthFailureException

createOrUpdateResource

protected com.microsoft.azure.management.appservice.WebAppBase createOrUpdateResource()
                                                                               throws AzureExecutionException,
                                                                                      AzureAuthFailureException

Throws:

AzureExecutionException

AzureAuthFailureException

createFunctionApp

protected com.microsoft.azure.management.appservice.FunctionApp createFunctionApp(FunctionRuntimeHandler runtimeHandler)
                                                                           throws AzureAuthFailureException,
                                                                                  AzureExecutionException

Throws:

AzureAuthFailureException

AzureExecutionException

updateFunctionApp

protected com.microsoft.azure.management.appservice.FunctionApp updateFunctionApp(com.microsoft.azure.management.appservice.FunctionApp app,
                                                                                  FunctionRuntimeHandler runtimeHandler)
                                                                           throws AzureAuthFailureException,
                                                                                  AzureExecutionException

Throws:

AzureAuthFailureException

AzureExecutionException

createDeploymentSlot

protected com.microsoft.azure.management.appservice.FunctionDeploymentSlot createDeploymentSlot(com.microsoft.azure.management.appservice.FunctionApp functionApp,
                                                                                                FunctionRuntimeHandler runtimeHandler)
                                                                                         throws AzureExecutionException,
                                                                                                AzureAuthFailureException

Throws:

AzureExecutionException

AzureAuthFailureException

updateDeploymentSlot

protected com.microsoft.azure.management.appservice.FunctionDeploymentSlot updateDeploymentSlot(com.microsoft.azure.management.appservice.FunctionDeploymentSlot deploymentSlot,
                                                                                                FunctionRuntimeHandler runtimeHandler)
                                                                                         throws AzureAuthFailureException,
                                                                                                AzureExecutionException

Throws:

AzureAuthFailureException

AzureExecutionException

listHTTPTriggerUrls

protected void listHTTPTriggerUrls()

List anonymous HTTP Triggers url after deployment

getFunctionRuntimeHandler

protected FunctionRuntimeHandler getFunctionRuntimeHandler()
                                                    throws AzureAuthFailureException,
                                                           AzureExecutionException

Throws:

AzureAuthFailureException

AzureExecutionException

getOsEnum

protected OperatingSystemEnum getOsEnum()
                                 throws AzureExecutionException

Throws:

AzureExecutionException

getArtifactHandler

protected ArtifactHandler getArtifactHandler()
                                      throws AzureExecutionException

Throws:

AzureExecutionException

getDeploymentTypeByRuntime

protected DeploymentType getDeploymentTypeByRuntime()
                                             throws AzureExecutionException

Throws:

AzureExecutionException

isDedicatedPricingTier

protected boolean isDedicatedPricingTier()
                                  throws AzureExecutionException

Throws:

AzureExecutionException

checkArtifactCompileVersion

protected void checkArtifactCompileVersion()
                                    throws AzureExecutionException

Throws:

AzureExecutionException

parseConfiguration

protected void parseConfiguration()

configureAppSettings

protected void configureAppSettings(java.util.function.Consumer<Map> withAppSettings,
                                    Map appSettings)

updateFunctionAppSettings

private com.microsoft.azure.management.appservice.WebAppBase.Update updateFunctionAppSettings(com.microsoft.azure.management.appservice.WebAppBase.Update update)
                                                                                       throws AzureExecutionException,
                                                                                              AzureAuthFailureException

Throws:

AzureExecutionException

AzureAuthFailureException

getArtifactToDeploy

private File getArtifactToDeploy()
                          throws AzureExecutionException

Throws:

AzureExecutionException

listFunctions

private List<FunctionResource> listFunctions()
                                      throws AzureExecutionException,
                                             AzureAuthFailureException,
                                             InterruptedException

Sync triggers and return function list of deployed function app Will retry when get empty result, the max retry times is LIST_TRIGGERS_MAX_RETRY

Returns:

List of functions in deployed function app

Throws:

AzureExecutionException - Throw if get empty result after LIST_TRIGGERS_MAX_RETRY times retry

AzureAuthFailureException - Throw if meet Authentication exception while getting Azure client or Function app

InterruptedException - Throw when thread was interrupted while sleeping between retry

bindApplicationInsights

private void bindApplicationInsights(Map appSettings,
                                     boolean isCreation)
                              throws AzureExecutionException,
                                     AzureAuthFailureException

Binding Function App with Application Insights Will follow the below sequence appInsightsKey -> appInsightsInstance -> Create New AI Instance (Function creation only)

Parameters:

appSettings - App settings map

isCreation - Define the stage of function app, as we only create ai instance by default when create new function apps

Throws:

AzureExecutionException - When there are conflicts in configuration or meet errors while finding/creating application insights instance

AzureAuthFailureException

validateApplicationInsightsConfiguration

private void validateApplicationInsightsConfiguration()
                                               throws AzureExecutionException

Throws:

AzureExecutionException

isDeployToSlot

private boolean isDeployToSlot()

getOrCreateApplicationInsights

private com.microsoft.azure.management.applicationinsights.v2015_05_01.ApplicationInsightsComponent getOrCreateApplicationInsights(boolean enableCreation)
                                                                                                                            throws AzureAuthFailureException

Throws:

AzureAuthFailureException

getApplicationInsights

private com.microsoft.azure.management.applicationinsights.v2015_05_01.ApplicationInsightsComponent getApplicationInsights(ApplicationInsightsManager applicationInsightsManager,
                                                                                                                           String appInsightsInstance)

createApplicationInsights

private com.microsoft.azure.management.applicationinsights.v2015_05_01.ApplicationInsightsComponent createApplicationInsights(ApplicationInsightsManager applicationInsightsManager,
                                                                                                                              String name)