Skip to content

Readme update for sasToken API in builder #5697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sima-zhu merged 9 commits into from
Oct 4, 2019
Merged

Readme update for sasToken API in builder #5697

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
db3a953
Fixed several missing parts
sima-zhu Oct 1, 2019
33ca9b8
Merge branch 'master' of https://github.com/Azure/azure-sdk-for-java …
sima-zhu Oct 1, 2019
d68d1ae
Merge branch 'rename' of https://github.com/sima-zhu/azure-sdk-for-ja…
sima-zhu Oct 1, 2019
a9ac150
Rename the setter parameter
sima-zhu Oct 1, 2019
7472596
Remove unnecessary changes
sima-zhu Oct 1, 2019
ab5eba4
Sas token changes
sima-zhu Oct 4, 2019
e366422
Changed the sas token in readme
sima-zhu Oct 4, 2019
9118375
Added change log for sas changes
sima-zhu Oct 4, 2019
fad1343
Minor
sima-zhu Oct 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sdk/storage/azure-storage-blob/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ and
- Renamed `setTier` to `setAccessTier` from `BlobAsyncClientBase` and `BlobClientBase` classes.
- Added `ParallelTransferOptions` to buffered upload, upload from file and download to file methods.
- Removed `Metadata` class and uses Map<String, String> for `matadata` field of `BlobProperties` and `ContainerProperties`.
- Removed generate SAS token APIs.

@alzimmermsft alzimmermsft Oct 4, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Removed generate SAS token APIs.
- Removed SAS token generation methods for client APIs, use {insert SAS token generation classes here} to create SAS tokens.

- Added `sasToken(String)` in client builder.

@alzimmermsft alzimmermsft Oct 4, 2019 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Added `sasToken(String)` in client builder.
- Replaced `credential(SASTokenCredential)` with `sasToken(String)` in client builder.

@alzimmermsft alzimmermsft Oct 4, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment about removing SASTokenCredential and SASTokenCredentialPolicy


## Version 12.0.0-preview.3 (2019-09-10)
For details on the Azure SDK for Java (September 2019 Preview) release, you can refer to the [release announcement](https://aka.ms/azure-sdk-preview3-java).
Expand Down
2 changes: 2 additions & 0 deletions sdk/storage/azure-storage-file/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ and
- Fixed metadata does not allow capital letter issue. [`Bug 5295`](https://github.com/Azure/azure-sdk-for-java/issues/5295)
- Updated the return type of `downloadToFile` API to `FileProperties` on sync API and `Mono<FileProperties>` on async API.
- `getFileServiceUrl`, `getShareUrl`, `getDirectoryUrl`, `getFileUrl` API now returns URL with scheme, host, resource name and snapshot if any.
- Removed generate SAS token APIs.
- Added `sasToken(String)` in client builder.

## Version 12.0.0-preview.3 (2019-09-10):
For details on the Azure SDK for Java (September 2019 Preview) release, you can refer to the [release announcement](https://aka.ms/azure-sdk-preview3-java).
Expand Down
2 changes: 2 additions & 0 deletions sdk/storage/azure-storage-queue/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ and
- Changed `VoidResponse` to `Response<Void>` on sync API, and `Mono<VoidResponse>` to `Mono<Response<Void>>` on async API.
- Fixed metadata does not allow capital letter issue. [`Bug 5295`](https://github.com/Azure/azure-sdk-for-java/issues/5295)
- `getQueueServiceUrl`, `getQueueUrl` API now returns URL with scheme, host, resource name and snapshot if any.
- Removed generate SAS token APIs.
- Added `sasToken(String)` in client builder.


## Version 12.0.0-preview.3 (2019-09-10)
Expand Down
8 changes: 4 additions & 4 deletions sdk/storage/azure-storage-queue/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ The client performs the interactions with the Queue service, create or delete a
Once you have the value of the SASToken you can create the queue service client with `${accountName}`, `${SASToken}`.
```Java
String queueServiceURL = String.format("https://%s.queue.core.windows.net", accountName);
QueueServiceClient queueServiceClient = new QueueServiceClientBuilder().endpoint(queueServiceURL).credential(SASToken).buildClient();
QueueServiceClient queueServiceClient = new QueueServiceClientBuilder().endpoint(queueURL).sasToken(SASToken).build();

QueueClient newQueueClient = queueServiceClient.createQueue("myqueue");
```
Expand All @@ -168,7 +168,7 @@ or
```Java
String queueServiceAsyncURL = String.format("https://%s.queue.core.windows.net/", accountName);
QueueServiceAsyncClient queueServiceAsyncClient = new QueueServiceClientBuilder().endpoint(queueServiceAsyncURL)
.credential(SASToken).buildAsyncClient();
.sasToken(SASToken).buildAsyncClient();
queueServiceAsyncClient.createQueue("newAsyncQueue").subscribe(
result -> {
// do something when new queue created
Expand All @@ -189,7 +189,7 @@ A single queue message can be up to 64 KB in size, and a queue can contain milli
Once you have the value of the SASToken you can create the queue service client with `${accountName}`, `${queueName}`, `${SASToken}`.
```Java
String queueURL = String.format("https://%s.queue.core.windows.net/%s", accountName, queueName);
QueueClient queueClient = new QueueClientBuilder().endpoint(queueURL).credential(SASToken).buildClient();
QueueClient queueClient = new QueueClientBuilder().endpoint(queueURL).sasToken(SASToken).buildClient();

// metadata is map of key-value pair
queueClient.createWithResponse(metadata, null, Duration.ofSeconds(30), Context.NONE);
Expand Down Expand Up @@ -392,7 +392,7 @@ The operation sets user-defined metadata on the specified queue. Metadata is ass
Use `${SASToken}` as credential.
```Java
String queueSURL = String.format("https://%s.queue.core.windows.net", accountName);
QueueClient queueClient = new QueueClientBuilder().endpoint(queueURL).credential(SASToken).queueName("myqueue").buildClient();
QueueClient queueClient = new QueueClientBuilder().endpoint(queueURL).sasToken(SASToken).queueName("myqueue").buildClient();

Map<String, String> metadata = new HashMap<String, String>() {{
put("key1", "val1");
Expand Down