Package com.microsoft.azure.maven
Class AbstractAppServiceMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- com.microsoft.azure.maven.AbstractAzureMojo
-
- com.microsoft.azure.maven.AbstractAppServiceMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled,org.apache.maven.plugin.Mojo
public abstract class AbstractAppServiceMojo extends AbstractAzureMojo
Base abstract class for all Azure App Service Mojos.
-
-
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 Description protected StringappNameName of the app service.protected com.microsoft.azure.toolkit.lib.appservice.AzureAppServiceappServiceClientprotected StringappServicePlanNameName of the app service plan.protected StringappServicePlanResourceGroupResource group of app service plan.protected PropertiesappSettingsApplication settings of App Service, in the form of name-value pairs.protected com.microsoft.azure.toolkit.lib.legacy.appservice.DeploymentSlotSettingdeploymentSlotSettingConfiguration for deployment Slot, will create new slot if target does not exist.protected static StringMAVEN_PLUGIN_POSTFIXprotected static StringPORTAL_URL_PATTERNprotected StringresourceGroupName of the resource group.-
Fields inherited from class com.microsoft.azure.maven.AbstractAzureMojo
allowTelemetry, auth, authType, buildDirectory, failsOnError, 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
-
-
Constructor Summary
Constructors Constructor Description AbstractAppServiceMojo()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetAppName()StringgetAppServicePlanName()StringgetAppServicePlanResourceGroup()MapgetAppSettings()com.microsoft.azure.toolkit.lib.legacy.appservice.DeploymentSlotSettinggetDeploymentSlotSetting()StringgetDeploymentStagingDirectoryPath()protected com.microsoft.azure.toolkit.lib.appservice.AzureAppServicegetOrCreateAzureAppServiceClient()protected static StringgetPortalUrl(com.azure.core.management.AzureEnvironment azureEnvironment)StringgetResourceGroup()StringgetResourcePortalUrl(String id)List<DeploymentResource>getResources()protected voidprintCurrentSubscription(com.microsoft.azure.toolkit.lib.appservice.AzureAppService appServiceClient)voidsetDeploymentSlot(com.microsoft.azure.toolkit.lib.legacy.appservice.DeploymentSlotSetting slotSetting)-
Methods inherited from class com.microsoft.azure.maven.AbstractAzureMojo
afterMojoExecution, beforeMojoExecution, checkSubscription, doExecute, execute, executeWithTimeRecorder, getActualAuthType, getAuthType, getAzureAccount, getBuildDirectoryAbsolutePath, getInstallationId, getPluginName, getPluginVersion, getTargetSubscriptionId, getTelemetryProperties, getUserAgent, highlightDefaultValue, infoWithMultipleLines, initTelemetryProxy, isSkipMojo, login, onMojoError, onSkipped, printCredentialDescription, selectSubscription, selectSubscription, trackMojoFailure, updateTelemetryProperties
-
-
-
-
Field Detail
-
MAVEN_PLUGIN_POSTFIX
protected static final String MAVEN_PLUGIN_POSTFIX
- See Also:
- Constant Field Values
-
PORTAL_URL_PATTERN
protected static final String PORTAL_URL_PATTERN
- See Also:
- Constant Field Values
-
resourceGroup
@Parameter(property="resourceGroup", required=false) protected String resourceGroupName of the resource group. It will be created if it doesn't exist.
-
appName
@Parameter(property="appName", required=false) protected String appNameName of the app service. It will be created if it doesn't exist.
-
appServicePlanResourceGroup
@Parameter(property="appServicePlanResourceGroup") protected String appServicePlanResourceGroup
Resource group of app service plan. It will be created if it doesn't exist.
-
appServicePlanName
@Parameter(property="appServicePlanName") protected String appServicePlanName
Name of the app service plan. It will be created if it doesn't exist.
-
deploymentSlotSetting
@Parameter(alias="deploymentSlot") protected com.microsoft.azure.toolkit.lib.legacy.appservice.DeploymentSlotSetting deploymentSlotSetting
Configuration for deployment Slot, will create new slot if target does not exist.Require the web app exists already.
Parameters for deployment slot
- name: Specifies the name for deployment slot.
- configurationSource: Specifies the configuration source of new created deployment slot, could be parent or existing deployment slot name, default value is parent
<deploymentSlotSetting> <name>Slot-Name</name> <configurationSource>Source</value> </deploymentSlotSetting>
-
appSettings
@Parameter protected Properties appSettings
Application settings of App Service, in the form of name-value pairs.<appSettings> <property> <name>setting-name</name> <value>setting-value</value> </property> </appSettings>
-
appServiceClient
protected com.microsoft.azure.toolkit.lib.appservice.AzureAppService appServiceClient
-
-
Method Detail
-
getResourceGroup
public String getResourceGroup()
-
getAppName
public String getAppName()
-
getAppServicePlanResourceGroup
public String getAppServicePlanResourceGroup()
-
getAppServicePlanName
public String getAppServicePlanName()
-
getAppSettings
public Map getAppSettings()
-
getDeploymentSlotSetting
public com.microsoft.azure.toolkit.lib.legacy.appservice.DeploymentSlotSetting getDeploymentSlotSetting()
-
getResources
public List<DeploymentResource> getResources()
-
getDeploymentStagingDirectoryPath
public String getDeploymentStagingDirectoryPath()
-
setDeploymentSlot
public void setDeploymentSlot(com.microsoft.azure.toolkit.lib.legacy.appservice.DeploymentSlotSetting slotSetting)
-
getPortalUrl
protected static String getPortalUrl(com.azure.core.management.AzureEnvironment azureEnvironment)
-
getOrCreateAzureAppServiceClient
protected com.microsoft.azure.toolkit.lib.appservice.AzureAppService getOrCreateAzureAppServiceClient()
-
printCurrentSubscription
protected void printCurrentSubscription(com.microsoft.azure.toolkit.lib.appservice.AzureAppService appServiceClient)
-
-