* Readme 1.10 (#437)

first draft

* adding changes for Batch AI

* updating migration notes
This commit is contained in:
Elena Lakhno 2018-05-07 16:25:09 -07:00 коммит произвёл Jianghao Lu
Родитель a887614131
Коммит 5f805485b8
2 изменённых файлов: 40 добавлений и 6 удалений

Просмотреть файл

@ -2,7 +2,7 @@
# Azure Management Libraries for Java
This README is based on the released stable version (1.9.0). If you are looking for other releases, see [More Information](#more-information).
This README is based on the released stable version (1.10.0). If you are looking for other releases, see [More Information](#more-information).
The Azure Management Libraries for Java is a higher-level, object-oriented API for *managing* Azure resources, that is optimized for ease of use, succinctness and consistency.
@ -24,7 +24,7 @@ If you are looking for Java client libraries for *consuming* (rather than *manag
* [More information](#more-information)
## Feature Availability and Road Map
:triangular_flag_on_post: *as of Version 1.9.0*
:triangular_flag_on_post: *as of Version 1.10.0*
<table>
<tr>
@ -603,13 +603,13 @@ SqlDatabase database = sqlServer.databases().define("myNewDatabase")
### Latest stable release
If you are using released builds from 1.6.0, add the following to your POM file:
If you are using released builds from 1.10.0, add the following to your POM file:
```xml
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure</artifactId>
<version>1.9.0</version>
<version>1.10.0</version>
</dependency>
```
@ -636,7 +636,7 @@ If you are using snapshots builds for this repo, add the following repository an
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure</artifactId>
<version>1.9.1-SNAPSHOT</version>
<version>1.10.1-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.microsoft.azure</groupId>
@ -663,7 +663,7 @@ If you are using snapshots builds for this repo, add the following repository an
## Upgrading from older versions
If you are migrating your code from 1.8.x to 1.9.0, you can use these release notes for [preparing your code for 1.9.0 from 1.8.x](./notes/prepare-for-1.9.0.md).
If you are migrating your code from 1.9.x to 1.10.0, you can use these release notes for [preparing your code for 1.10.0 from 1.9.x](./notes/prepare-for-1.10.0.md).
In general, Azure Libraries for Java follow [semantic versioning](http://semver.org/), so user code should continue working in a compatible fashion between minor versions of the same major version release train, with the following caveats:
@ -697,6 +697,7 @@ If you would like to become an active contributor to this project please follow
| Version | SHA1 | Remarks |
|-------------------|-------------------------------------------------------------------------------------------|-------------------------------------------------------|
| 1.10.0 | [1.10.0](https://github.com/Azure/azure-libraries-for-java/tree/v1.10.0) | Tagged release for 1.10.0 version of Azure management libraries |
| 1.9.0 | [1.9.0](https://github.com/Azure/azure-libraries-for-java/tree/v1.9.0) | Tagged release for 1.9.0 version of Azure management libraries |
| 1.8.0 | [1.8.0](https://github.com/Azure/azure-libraries-for-java/tree/v1.980) | Tagged release for 1.8.0 version of Azure management libraries |
| 1.7.0 | [1.7.0](https://github.com/Azure/azure-libraries-for-java/tree/v1.7.0) | Tagged release for 1.7.0 version of Azure management libraries |

Просмотреть файл

@ -0,0 +1,33 @@
# Prepare for Azure Management Libraries for Java 1.10.0 #
Steps to migrate code that uses Azure Management Libraries for Java from 1.9 to 1.10 ...
> If this note missed any breaking changes, please open a pull request.
V1.10 is backwards compatible with V1.9 in the APIs intended for public use that reached the general availability (stable) stage in V1.x with a few exceptions in the ==XXXX== management library (though these changes will have minimal impact on the developer).
Some breaking changes were introduced in APIs that were still in Beta in V1.9, as indicated by the `@Beta` annotation.
## Breaking changes
The following methods and/or types have been changed in V1.10 compared to the previous release (V1.9):
<table>
<tr>
<th align=left>Area/Model</th>
<th align=left>In V1.9</th>
<th align=left>In V1.10</th>
<th align=left>Remarks</th>
<th align=left>Ref</th>
</tr>
<tr>
<td><code>BatchAICluster</code></td>
<td><code>BatchAICluster.jobs()</code></td>
<td><code>Azure.batchAIJobs()</code></td>
<td>Changed entry point for Batch AI jobs management from <code>BatchAICluster.jobs()</code> to <code>Azure.batchAIJobs()</code></td>
<td><a href="https://github.com/Azure/azure-libraries-for-java/pull/434">PR #434</a></td>
</tr>
</table>