Skip to content

Commit

Permalink
bump verion to 0.1.6-SNAPSHOT and refine documentation (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
xscript authored Oct 30, 2017
1 parent 97d5b84 commit c245582
Show file tree
Hide file tree
Showing 6 changed files with 99 additions and 10 deletions.
47 changes: 45 additions & 2 deletions azure-functions-maven-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
- [Usage](#usage)
- [Common Configuration](#common-configuration)
- [Configuration](#configuration)
- [Supported Regions](#supported-regions)
- [Supported Pricing Tiers](#supported-pricing-tiers)
- [How To](#how-to)
- [Add new function to current project](#add-new-function-to-current-project)
- [Generate `function.json` from current project](#generate-functionjson-from-current-project)
Expand Down Expand Up @@ -85,10 +87,51 @@ Property | Required | Description
---|---|---
`<resourceGroup>` | true | Specifies the Azure Resource Group for your Function App.
`<appName>` | true | Specifies the name of your Function App.
`<region>` | false | Specifies the region where your Function App will be hosted; default value is **westus**.<br>This setting will be used to create a new Function App if specified Function App does not exist; if target Function App already exists, this setting will be ignored.
`<pricingTier>` | false | Specifies the pricing tier for your Function App; default value is **Consumption**.<br>This setting will be used to create a new Function App if specified Function App does not exist; if target Function App already exists, this setting will be ignored.
`<region>`* | false | Specifies the region where your Function App will be hosted; default value is **westus**. All valid regions are at [Supported Regions](#supported-regions) section.
`<pricingTier>`* | false | Specifies the pricing tier for your Function App; default value is **Consumption**. All valid pricing tiers are at [Supported Pricing Tiers](#supported-pricing-tiers) section.
`<appSettings>` | false | Specifies the application settings for your Function App, which are defined in name-value pairs like following example:<br>`<property>`<br>&nbsp;&nbsp;&nbsp;&nbsp;`<name>xxxx</name>`<br>&nbsp;&nbsp;&nbsp;&nbsp;`<value>xxxx</value>`<br>`</property>`
`<deploymentType>` | false | Specifies the deployment approach you want to use.<br>Supported values are `msdeploy` and `ftp`. Default value is **`msdeploy`**.
>*: This setting will be used to create a new Function App if specified Function App does not exist; if target Function App already exists, this setting will be ignored.
### Supported Regions
All valid regions are listed as below. Read more at [Azure Region Availability](https://azure.microsoft.com/en-us/regions/services/).
- `westus`
- `westus2`
- `eastus`
- `eastus2`
- `northcentralus`
- `southcentralus`
- `westcentralus`
- `canadacentral`
- `canadaeast`
- `brazilsouth`
- `northeurope`
- `westeurope`
- `uksouth`
- `eastasia`
- `southeastasia`
- `japaneast`
- `japanwest`
- `australiaeast`
- `australiasoutheast`
- `centralindia`
- `southindia`

### Supported Pricing Tiers
Consumption plan is the default if you don't specify anything for your Azure Functions.
You can also run Functions within your App Service Plan. All valid App Service plan pricing tiers are listed as below.
Read more at [Azure App Service Plan Pricing](https://azure.microsoft.com/en-us/pricing/details/app-service/).
- `F1`
- `D1`
- `B1`
- `B2`
- `B3`
- `S1`
- `S2`
- `S3`
- `P1`
- `P2`
- `P3`

## How-To

Expand Down
4 changes: 2 additions & 2 deletions azure-functions-maven-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>com.microsoft.azure</groupId>
<artifactId>azure-functions-maven-plugin</artifactId>
<version>0.1.5</version>
<version>0.1.6-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
<name>Maven Plugin for Azure Functions</name>
<description>Maven Plugin for Azure Functions</description>
Expand All @@ -22,7 +22,7 @@
<maven.plugin-testing.version>3.3.0</maven.plugin-testing.version>
<codehaus.plexus-utils.version>3.0.20</codehaus.plexus-utils.version>
<azure.ai.version>1.0.9</azure.ai.version>
<azure.maven-plugin-lib.version>0.1.5</azure.maven-plugin-lib.version>
<azure.maven-plugin-lib.version>0.1.6-SNAPSHOT</azure.maven-plugin-lib.version>
<azure.function.version>1.0.0-beta-1</azure.function.version>
<azure.storage.version>5.4.0</azure.storage.version>
<reflections.version>0.9.11</reflections.version>
Expand Down
2 changes: 1 addition & 1 deletion azure-maven-plugin-lib/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>com.microsoft.azure</groupId>
<artifactId>azure-maven-plugin-lib</artifactId>
<version>0.1.5</version>
<version>0.1.6-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Azure Maven Plugin Library</name>
<description>Common library for Azure Maven Plugins</description>
Expand Down
50 changes: 48 additions & 2 deletions azure-webapp-maven-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
- [Web Container](#web-container)
- [Web App on Linux](#web-app-on-linux)
- [Container Setting](#container-setting)
- [Supported Regions](#supported-regions)
- [Supported Pricing Tiers](#supported-pricing-tiers)


The Maven Plugin for Azure Web Apps provides seamless integration of Azure Web Apps into Maven,
Expand Down Expand Up @@ -76,14 +78,16 @@ Property | Required | Description
---|---|---
`<resourceGroup>` | true | Specifies the Azure Resource Group for your Web App.
`<appName>` | true | Specifies the name of your Web App.
`<region>` | false | Specifies the region where your Web App will be hosted; the default value is **westus**.<br>This setting will be used only when you are creating a new Web App; if the Web App already exists, this setting will be ignored.
`<pricingTier>` | false | Specifies the pricing tier for your Web App; the default value is **S1**.<br>This setting will be used only when you are creating a new Web App; if the Web App already exists, this setting will be ignored.
`<region>`* | false | Specifies the region where your Web App will be hosted; the default value is **westus**. All valid regions at [Supported Regions](#supported-regions) section.
`<pricingTier>`* | false | Specifies the pricing tier for your Web App; the default value is **S1**. All valid tiers are at [Supported Pricing Tiers](#supported-pricing-tiers) section.
`<javaVersion>` | false | Specifies the JVM version for your Web App.<br>This setting is only applicable for normal Web App (Windows based); see the [Java Runtime](#java-runtime) section of this README for details.
`<javaWebContainer>` | false | Specified the Web Container for your Web App.<br>This setting is only applicable for normal Web App (Windows based); see the [Web Container](#web-container) section of this README for details.
`<containerSettings>` | false | Specifies the docker container image to deploy to your Web App.<br>Docker hubs and private container registries are both supported; see the [Container Setting](#container-setting) section of this README for details.
`<appSettings>` | false | Specifies the application settings for your Web App, which are defined in name-value pairs like following example:<br>`<property>`<br>&nbsp;&nbsp;&nbsp;&nbsp;`<name>xxxx</name>`<br>&nbsp;&nbsp;&nbsp;&nbsp;`<value>xxxx</value>`<br>`</property>`
`<deploymentType>` | false | Specifies the deployment approach you want to use. Only `ftp` is supported right now.
`<stopAppDuringDeployment>` | false | Specifies whether stop target Web App during deployment. This will prevent deployment failure caused by IIS locking files.
`<resources>` | false | Specifies the artifacts to be deployed to your Web App; see the [Deploy via FTP](#deploy-via-ftp) section for more details.
>*: This setting will be used only when you are creating a new Web App; if the Web App already exists, this setting will be ignored
### Web App (on Windows)

Expand Down Expand Up @@ -202,3 +206,45 @@ Property | Required | Description

Check out samples at [Web App Samples](../docs/web-app-samples.md) for the configuration settings for different image sources.

### Supported Regions
All valid regions are listed as below. Read more at [Azure Region Availability](https://azure.microsoft.com/en-us/regions/services/).
- `westus`
- `westus2`
- `centralus`
- `eastus`
- `eastus2`
- `northcentralus`
- `southcentralus`
- `westcentralus`
- `canadacentral`
- `canadaeast`
- `brazilsouth`
- `northeurope`
- `westeurope`
- `uksouth`
- `ukwest`
- `eastasia`
- `southeastasia`
- `japaneast`
- `japanwest`
- `australiaeast`
- `australiasoutheast`
- `centralindia`
- `southindia`
- `westindia`
- `koreacentral`
- `koreasouth`

### Supported Pricing Tiers
All valid pricing tiers are listed as below. Read more at [Azure App Service Plan Pricing](https://azure.microsoft.com/en-us/pricing/details/app-service/).
- `F1`
- `D1`
- `B1`
- `B2`
- `B3`
- `S1`
- `S2`
- `S3`
- `P1`
- `P2`
- `P3`
4 changes: 2 additions & 2 deletions azure-webapp-maven-plugin/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>com.microsoft.azure</groupId>
<artifactId>azure-webapp-maven-plugin</artifactId>
<version>0.1.5</version>
<version>0.1.6-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
<name>Maven Plugin for Azure Web Apps</name>
<description>Maven Plugin for Azure Web Apps</description>
Expand All @@ -22,7 +22,7 @@
<maven.plugin-testing.version>3.3.0</maven.plugin-testing.version>
<codehaus.plexus-utils.version>3.0.20</codehaus.plexus-utils.version>
<azure.ai.version>1.0.9</azure.ai.version>
<azure.maven-plugin-lib.version>0.1.5</azure.maven-plugin-lib.version>
<azure.maven-plugin-lib.version>0.1.6-SNAPSHOT</azure.maven-plugin-lib.version>
<junit.version>4.12</junit.version>
<mockito.version>2.4.0</mockito.version>
<spring-test.version>4.1.6.RELEASE</spring-test.version>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<groupId>com.microsoft.azure</groupId>
<artifactId>azure-maven-plugins</artifactId>
<version>0.1.5</version>
<version>0.1.6-SNAPSHOT</version>
<packaging>pom</packaging>
<name>Maven Plugins for Azure</name>
<description>Maven plugins for Microsoft Azure services</description>
Expand Down

0 comments on commit c245582

Please sign in to comment.