Skip to content

Commit

Permalink
Clean up markdown files (Azure#121)
Browse files Browse the repository at this point in the history
* Trim whitespaces

* Clean extra lines
  • Loading branch information
carusogabriel authored and vinjiang committed Jan 25, 2018
1 parent 883a16b commit 1e239c4
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 24 deletions.
2 changes: 1 addition & 1 deletion BreakingChanges.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Blob
- `MicrosoftAzure\Storage\Blob\Models\BlobProperties::getContentMD5()` will always return the value of the whole blob’s MD5 value.
- Added `MicrosoftAzure\Storage\Blob\Models\BlobProperties::getRangeContentMD5()` to get MD5 of a blob range.
* `MicrosoftAzure\Storage\Blob\Models\GetBlobOptions` and `MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions` now provide `setRange()` and `getRange()` to accept a `MicrosoftAzure\Storage\Common\Models\Range` object. Following methods are removed:
- `setRangeStart()`
- `setRangeStart()`
- `getRangeStart()`
- `setRangeEnd()`
- `getRangeEnd()`
Expand Down
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,4 @@ Changes should be based on the `dev` branch. We're following [semver](http://sem
### Review Process
We expect all guidelines to be met before accepting a pull request. As such, we will work with you to address issues we find by leaving comments in your code. Please understand that it may take a few iterations before the code is accepted as we maintain high standards on code quality. Once we feel comfortable with a contribution, we will validate the change and accept the pull request.


Thank you for any contributions! Please let the team know if you have any questions or concerns about our contribution policy.
15 changes: 7 additions & 8 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ All
* Fixed formatting of non-UTC dates when using instances of `DateTime` to generate shared access signatures.
* Fixed class loading errors on case-sensitive file systems when testing.

Blob
Blob
* Added `CopyBlobFromURL` to support copy blob from a source URL including resources in other storage accounts.
* Added support for Incremental Copy Page Blob. This allows efficient copying and backup of page blob snapshots.
* Fixed a bug that `BlobRestProxy::createPageBlobFromContent` cannot work.
Expand All @@ -62,7 +62,7 @@ Blob
- `setComputeRangeMD5()` -> `setRangeGetContentMD5()`
* The public access level of a container is now returned from the List Containers and Get Container Properties APIs.
* `MicrosoftAzure\Storage\Blob\Models\GetBlobOptions` and `MicrosoftAzure\Storage\Blob\Models\ListPageBlobRangesOptions` now provide `setRange()` and `getRange()` to accept a `MicrosoftAzure\Storage\Common\Models\Range` object. Following methods are removed:
- `setRangeStart()`
- `setRangeStart()`
- `getRangeStart()`
- `setRangeEnd()`
- `getRangeEnd()`
Expand All @@ -72,7 +72,7 @@ Queue

File
* Fixed a bug that setting content MD5 cannot work when creating files.
* Option parameter `ListDirectoriesAndFilesOptions` of `FileRestProxy::listDirectoriesAndFiles` is now able to set a prefix which limits the listing to a specified prefix.
* Option parameter `ListDirectoriesAndFilesOptions` of `FileRestProxy::listDirectoriesAndFiles` is now able to set a prefix which limits the listing to a specified prefix.
* Populate content MD5 for range gets on Files.
- `MicrosoftAzure\Storage\File\Models\FileProperties::getContentMD5()` will always return the value of the whole file’s MD5 value.
- Added `MicrosoftAzure\Storage\File\Models\FileProperties::getRangeContentMD5()` to get MD5 of a file range.
Expand All @@ -88,7 +88,7 @@ All
Blob
* Added `BlobRestProxy::listPageBlobRangesDiff` and `BlobRestProxy::listPageBlobRangesDiffAsync` for getting page ranges difference. Refer to https://msdn.microsoft.com/en-us/library/azure/mt736912.aspx for more detailed information.
* Following methods of `MicrosoftAzure\Storage\Blob\BlobRestProxy` now return the x-ms-request-server-encrypted response header. This header is set to true if the contents of the request have been successfully encrypted.
- `createBlockBlob`, `createPageBlob`, `createAppendBlob`, `createBlobPages`, `createBlobBlock`, `appendBlock`, `commitBlobBlocks` and `setBlobMetadata`.
- `createBlockBlob`, `createPageBlob`, `createAppendBlob`, `createBlobPages`, `createBlobBlock`, `appendBlock`, `commitBlobBlocks` and `setBlobMetadata`.
* Following methods of `MicrosoftAzure\Storage\Blob\BlobRestProxy` now return the x-ms-server-encrypted response header. This header is set to true if the blob data and application metadata are completely encrypted. If the blob is not encrypted, or if only parts of the blob/application metadata are encrypted, this header is set to false.
- `getBlob` and `getBlobProperties`.

Expand Down Expand Up @@ -175,7 +175,7 @@ Blob
* Refactored Options class:
- Exracted `getLeaseId`, `setLeaseId`, `getAccessConditions` and `setAccessConditions` to the base options class `BlobServiceOptions`.
- Refactored the `CreateBlobOptions`, `CommitBlobBlocksOptions` class to remove duplicate options and standardize the content settings related properties like `ContentType`, `ContentMD5`, `ContentEncoding`, `ContentLanguage`, `CacheControl` and `ContentDisposition`.

* Blob service properties feature parity:
- Added `getDefaultServiceVersion`, `setDefaultServiceVersion`, `getMinuteMetrics` and `setMinuteMetrics` to `ServiceProperties` class.

Expand All @@ -184,13 +184,12 @@ Blob
* Added `getServiceStats` and `getServiceStatsAsync` for user to request service statistics from the server's secondary endpoint.

Table
* Removed `MicrosoftAzure\Storage\Table\Models\BatchError`. When batch operation fails, exception is thrown immediately instead.
* Removed `MicrosoftAzure\Storage\Table\Models\BatchError`. When batch operation fails, exception is thrown immediately instead.
* Added `getServiceStats` and `getServiceStatsAsync` for user to request service statistics from the server's secondary endpoint.

Queue
* Added `getServiceStats` and `getServiceStatsAsync` for user to request service statistics from the server's secondary endpoint.


2017.04 - version 0.14.0

ALL
Expand Down Expand Up @@ -304,7 +303,7 @@ Blob
acquireLease
```
* Merged `StorageAuthScheme` into `SharedKeyAuthScheme` and `TableSharedKeyLiteAuthScheme` now inherits `SharedKeyAuthScheme`. This is because Azure Storage now supports Shared Key authentication and SAS authentication so the name `StorageAuthScheme` was not representative anymore.
* Fixed an issue where the newest Guzzle failed to validate the path passed in when `withPath()` is called.
* Fixed an issue where the newest Guzzle failed to validate the path passed in when `withPath()` is called.
2016.11 - version 0.11.0
Expand Down
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This project provides a set of PHP client libraries that make it easy to access
* azure-storage-common [![Latest Stable Version](https://poser.pugx.org/microsoft/azure-storage-common/v/stable)](https://packagist.org/packages/microsoft/azure-storage-common)

> **Note**
>
>
> * If you are looking for the Service Bus, Service Runtime, Service Management or Media Services libraries, please visit https://github.com/Azure/azure-sdk-for-php.
> * If you need big file (larger than 2GB) or 64-bit integer support, please install PHP 7 64-bit version.
Expand Down Expand Up @@ -53,7 +53,6 @@ To get the source code from GitHub, type
git clone https://github.com/Azure/azure-storage-php.git
cd ./azure-storage-php


## Install via Composer

1. Create a file named **composer.json** in the root of your project and add the following code to it:
Expand All @@ -75,12 +74,12 @@ To get the source code from GitHub, type

## Usage

There are four basic steps that have to be performed before you can make a call to any Microsoft Azure Storage API when using the libraries.
There are four basic steps that have to be performed before you can make a call to any Microsoft Azure Storage API when using the libraries.

* First, include the autoloader script:
require_once "vendor/autoload.php";

require_once "vendor/autoload.php";

* Include the namespaces you are going to use.

To create any Microsoft Azure service client you need to use the rest proxy classes, such as **BlobRestProxy** class:
Expand All @@ -91,14 +90,13 @@ There are four basic steps that have to be performed before you can make a call

use MicrosoftAzure\Storage\Common\ServiceException;


* To instantiate the service client you will also need a valid [connection string](https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/). The format is:
* To instantiate the service client you will also need a valid [connection string](https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/). The format is:

DefaultEndpointsProtocol=[http|https];AccountName=[yourAccount];AccountKey=[yourKey]

Or:
BlobEndpoint=myBlobEndpoint;QueueEndpoint=myQueueEndpoint;TableEndpoint=myTableEndpoint;FileEndpoint=myFileEndpoint;SharedAccessSignature=sasToken

BlobEndpoint=myBlobEndpoint;QueueEndpoint=myQueueEndpoint;TableEndpoint=myTableEndpoint;FileEndpoint=myFileEndpoint;SharedAccessSignature=sasToken

* Instantiate a client object - a wrapper around the available calls for the given service.

Expand Down Expand Up @@ -151,13 +149,12 @@ cURL can't verify the validity of Microsoft certificate when trying to issue a r
You can find samples in the [sample folder](samples)
# Migrate from [Azure SDK for PHP](https://github.com/Azure/azure-sdk-for-php/)
If you are using [Azure SDK for PHP](https://github.com/Azure/azure-sdk-for-php/) to access Azure Storage Service, we highly recommend you to migrate to this SDK for faster issue resolution and quicker feature implementation. We are working on supporting the latest service features as well as improvement on existing APIs.
For now, Microsoft Azure Storage PHP client libraries share almost the same interface as the storage blobs, tables, queues and files APIs in Azure SDK for PHP. However, there are some minor breaking changes need to be addressed during your migration. You can find the details in [BreakingChanges.md](BreakingChanges.md).
# Need Help?
Be sure to check out the Microsoft Azure [Developer Forums on Stack Overflow](http://go.microsoft.com/fwlink/?LinkId=234489) and [github issues](https://github.com/Azure/azure-storage-php/issues) if you have trouble with the provided code.
Expand All @@ -166,5 +163,5 @@ Be sure to check out the Microsoft Azure [Developer Forums on Stack Overflow](ht
If you would like to become an active contributor to this project please follow the instructions provided in [Azure Projects Contribution Guidelines](http://azure.github.io/guidelines/).
You can find more details for contributing in the [CONTRIBUTING.md](CONTRIBUTING.md).
If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/Azure/azure-storage-php/issues) section of the project.
If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/Azure/azure-storage-php/issues) section of the project.

0 comments on commit 1e239c4

Please sign in to comment.