com.microsoft.azure.maven.function

Class DeployMojo

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

com.microsoft.azure.maven.function.DeployMojo

All Implemented Interfaces:

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

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

Deploy your project to target Azure Functions. If target Function App 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	APP_NAME_PATTERN
private static String	APP_SERVICE_PLAN_NAME_PATTERN
private static String	APPLICATION_INSIGHTS_CONFIGURATION_CONFLICT
private static String	ARTIFACT_INCOMPATIBLE_ERROR
private static String	ARTIFACT_INCOMPATIBLE_WARNING
static String	CV2_INVALID_ALWAYS_READY_INSTANCE
private static String	CV2_INVALID_CONTAINER_SIZE
static String	CV2_INVALID_JAVA_VERSION
private static String	CV2_INVALID_MAX_INSTANCE
private static String	CV2_INVALID_RUNTIME
protected String	deploymentType The deployment approach to use, valid values are FTP, ZIP, MSDEPLOY, RUN_FROM_ZIP, RUN_FROM_BLOB
private static String	EMPTY_APP_NAME
private static String	EMPTY_IMAGE_NAME
private static String	EMPTY_RESOURCE_GROUP
private static String	EMPTY_SLOT_NAME
private static String	EXPANDABLE_JAVA_VERSION_WARNING
private static String	EXPANDABLE_PRICING_TIER_WARNING
private static String	EXPANDABLE_REGION_WARNING
private static String	INVALID_APP_NAME
private static String	INVALID_OS
private static String	INVALID_RESOURCE_GROUP_NAME
private static String	INVALID_SERVICE_PLAN_NAME
private static String	INVALID_SERVICE_PLAN_RESOURCE_GROUP_NAME
private static String	INVALID_SLOT_NAME
static int	MAX_MAX_INSTANCES
private static String	NO_ARTIFACT_FOUNDED
private static String	RESOURCE_GROUP_PATTERN
private static String	SLOT_NAME_PATTERN
private static List<Integer>	VALID_CONTAINER_SIZE

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

alwaysReadyInstances, appInsightsInstance, appInsightsKey, artifactPath, AZURE_FUNCTIONS_JAVA_LIBRARY, CAN_NOT_FIND_ARTIFACT, disableAppInsights, enableDistributedTracing, environment, finalName, FUNCTION_EXTENSION_LIBRARY_MAP, HOST_JSON, hostJson, instanceSize, LOCAL_SETTINGS_JSON, localSettingsJson, maximumInstances, maxReplicas, minReplicas, outputDirectory, parser, pricingTier, region, runtime, skip, storageAccountName, storageAccountResourceGroup, 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
DeployMojo()

Method Summary

Modifier and Type	Method and Description
private FunctionAppConfig	buildDefaultConfig(String subscriptionId, String resourceGroup, String appName)
protected FunctionAppBase<?,?,?>	createOrUpdateResource(FunctionApp app)
private void	deployArtifact(FunctionAppBase<?,?,?> target)
protected void	doExecute()
protected void	doValidate()
private void	mergeCommandLineConfig()
private void	validateApplicationInsightsConfiguration()
private void	validateArtifactCompileVersion()
protected void	validateParameters() Deprecated.

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

getAppInsightsInstance, getAppInsightsKey, getArtifact, getBundleVersion, getFinalName, getFunctionLibraryVersion, getHostJsonFile, getLocalSettingsJsonFile, getRegion, getRuntimeConfiguration, getTelemetryProperties, isDisableAppInsights, isSkipMojo, readHostJson, validateAppName, 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, 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

APPLICATION_INSIGHTS_CONFIGURATION_CONFLICT

private static final String APPLICATION_INSIGHTS_CONFIGURATION_CONFLICT

See Also:

Constant Field Values

ARTIFACT_INCOMPATIBLE_WARNING

private static final String ARTIFACT_INCOMPATIBLE_WARNING

See Also:

Constant Field Values

ARTIFACT_INCOMPATIBLE_ERROR

private static final String ARTIFACT_INCOMPATIBLE_ERROR

See Also:

Constant Field Values

NO_ARTIFACT_FOUNDED

private static final String NO_ARTIFACT_FOUNDED

See Also:

Constant Field Values

APP_NAME_PATTERN

private static final String APP_NAME_PATTERN

See Also:

Constant Field Values

RESOURCE_GROUP_PATTERN

private static final String RESOURCE_GROUP_PATTERN

See Also:

Constant Field Values

SLOT_NAME_PATTERN

private static final String SLOT_NAME_PATTERN

See Also:

Constant Field Values

APP_SERVICE_PLAN_NAME_PATTERN

private static final String APP_SERVICE_PLAN_NAME_PATTERN

See Also:

Constant Field Values

VALID_CONTAINER_SIZE

private static final List<Integer> VALID_CONTAINER_SIZE

EMPTY_APP_NAME

private static final String EMPTY_APP_NAME

See Also:

Constant Field Values

INVALID_APP_NAME

private static final String INVALID_APP_NAME

See Also:

Constant Field Values

EMPTY_RESOURCE_GROUP

private static final String EMPTY_RESOURCE_GROUP

See Also:

Constant Field Values

INVALID_RESOURCE_GROUP_NAME

private static final String INVALID_RESOURCE_GROUP_NAME

See Also:

Constant Field Values

INVALID_SERVICE_PLAN_NAME

private static final String INVALID_SERVICE_PLAN_NAME

See Also:

Constant Field Values

INVALID_SERVICE_PLAN_RESOURCE_GROUP_NAME

private static final String INVALID_SERVICE_PLAN_RESOURCE_GROUP_NAME

See Also:

Constant Field Values

EMPTY_SLOT_NAME

private static final String EMPTY_SLOT_NAME

See Also:

Constant Field Values

INVALID_SLOT_NAME

private static final String INVALID_SLOT_NAME

See Also:

Constant Field Values

EMPTY_IMAGE_NAME

private static final String EMPTY_IMAGE_NAME

See Also:

Constant Field Values

INVALID_OS

private static final String INVALID_OS

See Also:

Constant Field Values

EXPANDABLE_PRICING_TIER_WARNING

private static final String EXPANDABLE_PRICING_TIER_WARNING

See Also:

Constant Field Values

EXPANDABLE_REGION_WARNING

private static final String EXPANDABLE_REGION_WARNING

See Also:

Constant Field Values

EXPANDABLE_JAVA_VERSION_WARNING

private static final String EXPANDABLE_JAVA_VERSION_WARNING

See Also:

Constant Field Values

CV2_INVALID_CONTAINER_SIZE

private static final String CV2_INVALID_CONTAINER_SIZE

See Also:

Constant Field Values

CV2_INVALID_RUNTIME

private static final String CV2_INVALID_RUNTIME

See Also:

Constant Field Values

CV2_INVALID_MAX_INSTANCE

private static final String CV2_INVALID_MAX_INSTANCE

See Also:

Constant Field Values

MAX_MAX_INSTANCES

public static final int MAX_MAX_INSTANCES

See Also:

Constant Field Values

CV2_INVALID_ALWAYS_READY_INSTANCE

public static final String CV2_INVALID_ALWAYS_READY_INSTANCE

See Also:

Constant Field Values

CV2_INVALID_JAVA_VERSION

public static final String CV2_INVALID_JAVA_VERSION

See Also:

Constant Field Values

deploymentType

@Parameter(property="deploymentType")
protected String deploymentType

The deployment approach to use, valid values are FTP, ZIP, MSDEPLOY, RUN_FROM_ZIP, RUN_FROM_BLOB

For Windows Function Apps, the default deployment method is RUN_FROM_ZIP

For Linux Function Apps, RUN_FROM_BLOB will be used for apps with Consumption and Premium App Service Plan, RUN_FROM_ZIP will be used for apps with Dedicated App Service Plan.

Since:

0.1.0

Constructor Detail

DeployMojo

public DeployMojo()

Method Detail

doExecute

protected void doExecute()
                  throws Throwable

Specified by:

doExecute in class AbstractAzureMojo

Throws:

Throwable

mergeCommandLineConfig

private void mergeCommandLineConfig()

doValidate

protected void doValidate()
                   throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

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

validateArtifactCompileVersion

private void validateArtifactCompileVersion()
                                     throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

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

validateParameters

@Deprecated
protected void validateParameters()

Deprecated.

createOrUpdateResource

protected FunctionAppBase<?,?,?> createOrUpdateResource(FunctionApp app)
                                                 throws Throwable

Throws:

Throwable

buildDefaultConfig

private FunctionAppConfig buildDefaultConfig(String subscriptionId,
                                             String resourceGroup,
                                             String appName)

deployArtifact

private void deployArtifact(FunctionAppBase<?,?,?> target)

validateApplicationInsightsConfiguration

private void validateApplicationInsightsConfiguration()
                                               throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

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