Skip to content
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.

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

[JS] September release notes #1750

Merged
merged 26 commits into from
Sep 15, 2020
Merged
Changes from 21 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
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
211 changes: 205 additions & 6 deletions releases/2020-09/js.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,43 @@ The Azure SDK team is pleased to make available the September 2020 client librar

#### GA

- _Add packages_
- Azure Form Recognizer

#### Updates

- _Add packages_
- Core Libraries
- Azure Storage
- Azure Event Hubs

#### Preview

- _Add packages_
- Identity
- Azure Event Grid
- Azure Key Vault
- Azure Service Bus
- Azure Tables
- Azure Storage Blob Changefeed

## Installation Instructions

To install the packages, copy and paste the below into a terminal.

```bash
$> npm install @azure/package-name
$> npm install @azure/ai-form-recognizer
$> npm install @azure/storage-queue
$> npm install @azure/storage-file-share
$> npm install @azure/storage-file-datalake
$> npm install @azure/storage-blob
$> npm install @azure/event-hubs
sadasant marked this conversation as resolved.
Show resolved Hide resolved
$> npm install @azure/identity@next
$> npm install @azure/eventgrid@next
$> npm install @azure/keyvault-keys@next
$> npm install @azure/keyvault-secrets@next
$> npm install @azure/keyvault-certificates@next
$> npm install @azure/keyvault-admin@next
$> npm install @azure/service-bus@next
$> npm install @azure/data-tables@next
$> npm install @azure/storage-blob-changefeed@next
```

## Feedback
Expand All @@ -36,9 +57,187 @@ If you have a bug or feature request for one of the libraries, please post an is

Detailed changelogs are linked from the [Quick Links](#quick-links) below. Here are some of the highlights:
jongio marked this conversation as resolved.
Show resolved Hide resolved

### _Package name_

- Major changes only!
### Azure Form Recognizer

We are pleased to announce the general availability (GA) of the `@azure/ai-form-recognizer` package version 3.0.0.

#### Azure Form Recognizer [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md)
jongio marked this conversation as resolved.
Show resolved Hide resolved

##### Features
- Train and utilize custom and/or predefined AI models to extract information from text document images.
- Uses the Azure Form Recognizer v2.0 (GA) endpoint for the latest service features.


### Azure Storage
ljian3377 marked this conversation as resolved.
Show resolved Hide resolved

#### Azure Storage Blob [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/CHANGELOG.md)

##### New Features on @azure/[email protected]

- Supported RehydratePriority.
- Supported Object Replication Service.
- Supported Append Blob Seal.
- Supported Tags conditional operations.
- The Static Website Service now supports a DefaultIndexDocumentPath for a global HTTP 200 route within the static website. You can get it by `BlobServiceClient.getProperties()` and set it via `blobServiceClient.setProperties()`.

##### Major Fixes on @azure/[email protected]

- The `credential` parameter of `newPipeline()` function is now optional. If not specified, `AnonymousCredential` is used. Fixes bug [9628](https://github.com/Azure/azure-sdk-for-js/issues/9628).
- High level upload functions `BlockBlobClient.uploadFile()`, `BlockBlobClient.uploadStream()` and `BlockBlobClient.uploadBrowserData()` now support setting tier. Fixes bug [9062](https://github.com/Azure/azure-sdk-for-js/issues/9062).
- The Content-Length header is no longer ignored. Fixes bugs [8903](https://github.com/Azure/azure-sdk-for-js/issues/8903), [9300](https://github.com/Azure/azure-sdk-for-js/issues/9300) and [10614](https://github.com/Azure/azure-sdk-for-js/issues/10614).

#### Azure Data Lake Storage [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-datalake/CHANGELOG.md)

##### New Features on @azure/[email protected]

- Supported Quick Query. Added a new API `DataLakeFileClient.query()`.

##### Major Fixes on @azure/[email protected]

- The `credential` parameter of `newPipeline()` function is now optional. If not specified, `AnonymousCredential` is used. Fixes bug [9628](https://github.com/Azure/azure-sdk-for-js/issues/9628).
- The Content-Length header is no more ignored. Fixes bugs [8903](https://github.com/Azure/azure-sdk-for-js/issues/8903), [9300](https://github.com/Azure/azure-sdk-for-js/issues/9300) and [10614](https://github.com/Azure/azure-sdk-for-js/issues/10614).

#### Azure Storage File Share [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/CHANGELOG.md)

##### New Features on @azure/[email protected]

- Supported share soft delete. Added `undeleteShare` to `ShareServiceClient`. `listShares` now can return deleted shares. Note: share soft delete only take effect on accounts with share soft delete feature enabled.

##### Major Fixes on @azure/[email protected]

- The `credential` parameter of `newPipeline()` function is now optional. If not specified, `AnonymousCredential` is used. Fixes bug [9628](https://github.com/Azure/azure-sdk-for-js/issues/9628).
- The Content-Length header is no more ignored. Fixes bugs [8903](https://github.com/Azure/azure-sdk-for-js/issues/8903), [9300](https://github.com/Azure/azure-sdk-for-js/issues/9300) and [10614](https://github.com/Azure/azure-sdk-for-js/issues/10614).

#### Azure Storage Queue [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/CHANGELOG.md)

##### Major Fixes on @azure/[email protected]

- The `credential` parameter of `newPipeline()` function is now optional. If not specified, `AnonymousCredential` is used. Fixes bug [9628](https://github.com/Azure/azure-sdk-for-js/issues/9628).
- The Content-Length header is no longer ignored. Fixes bugs [8903](https://github.com/Azure/azure-sdk-for-js/issues/8903), [9300](https://github.com/Azure/azure-sdk-for-js/issues/9300) and [10614](https://github.com/Azure/azure-sdk-for-js/issues/10614).

#### Azure Storage Blob Change Feed [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob-changefeed/CHANGELOG.md)

##### New Features on @azure/[email protected]

- Supported `abortSignal` when fetching Change Feed events.
- Added new constructor overloads for the `BlobChangeFeedClient`.


### Azure Event Hubs

#### Azure Event Hubs [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/event-hubs/CHANGELOG.md)

#### New Features in @azure/[email protected]

- Adds `loadBalancingOptions` to the `EventHubConsumerClient` to add control around
how aggressively the client claims partitions while load balancing.
([PR 9706](https://github.com/Azure/azure-sdk-for-js/pull/9706)).
jongio marked this conversation as resolved.
Show resolved Hide resolved
- Support using the SharedAccessSignature from the connection string.
jongio marked this conversation as resolved.
Show resolved Hide resolved
([PR 10951](https://github.com/Azure/azure-sdk-for-js/pull/10951)).


#### Azure Event Grid

We're releasing a new preview for the Azure Event Grid client, with some API improvements.

##### Azure Event Grid [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventgrid/eventgrid/CHANGELOG.md)

##### New Features on @azure/[email protected]

- The Event Grid SDK now supports sending and deserializing events using the Cloud Events 1.0 schema.
jongio marked this conversation as resolved.
Show resolved Hide resolved


#### Azure Key Vault

We're releasing four beta versions of the Azure Key Vault packages. The the `4.2.0-beta.1` version of Key Vault Keys, Secrets and Certificates have a new feature that allows parsing the Ids of their respective keys, secrets and certficates. The package for Key Vault Keys in particular now provides a new client called `LocalCryptographyClient`. We're also announcing a brand new package called Key Vault Administration (`@azure/keyvault-admin` on NPM) which is releasing two new clients, `KeyVaultAccessControlClient` and `KeyVaultBackupClient`.
jongio marked this conversation as resolved.
Show resolved Hide resolved

#### Changelogs

- [Key Vault Keys](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/CHANGELOG.md).
- [Key Vault Secrets](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/CHANGELOG.md).
- [Key Vault Certificates](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/CHANGELOG.md).
- [Key Vault Administration](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/CHANGELOG.md).

##### New Features on @azure/[email protected]

- Added `parseKeyVaultKeysIdentifier` and `ParsedKeyVaultKeysIdentifier` to help with parsing the unique identifiers of Key Vault Keys.
- Added the basic structure of a new client to perform local cryptography operations, which is now called `LocalCryptographyClient`.
- The existing `CryptographyClient`, when initialized, will create one instance of a local cryptography client, which can be retrieved by calling to a new method that is part of the `CryptographyClient` class: `getLocalCryptographyClient()`.
- The `LocalCryptographyClient` currently has limited support of the cryptography operations available on the `CryptographyClient`. More operations will be added over time.

##### New Features on @azure/[email protected]

- Added `parseKeyVaultSecretsIdentifier` and `ParsedKeyVaultSecretsIdentifier` to help with parsing the unique identifiers of Key Vault Secrets.

##### New Features on @azure/[email protected]

- Added `parseKeyVaultCertificatesIdentifier` and `ParsedKeyVaultCertificatesIdentifier` to help with parsing the unique identifiers of Key Vault Certificates.

##### New Features on @azure/[email protected]

The @azure/keyvault-admin package provides two clients, `KeyVaultAccessControlClient` and `KeyVaultBackupClient`.

- The `KeyVaultAccessControlClient` allows working with role-based access control (RBAC) operations, meaning assigning, deleting and retrieving role assignments, and retrieving role definitions.
- The `KeyVaultBackupClient` allows generating full backups and restores of Key Vault instances, and selective restores of keys.


### Azure Service Bus

We're releasing a new preview for the Azure Service Bus, with some API changes and new features.

#### Azure Service Bus [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/servicebus/service-bus/CHANGELOG.md)

#### Breaking Changes in @azure/[email protected]

- API Changes:
- `SessionReceiver.sessionLockedUntilUtc` is readonly and never undefined.
[PR 10625](https://github.com/Azure/azure-sdk-for-js/pull/10625)
- `ServiceBusClient.createDeadLetterReceiver()` has been absorbed into `createReceiver()`.
To create a dead letter receiver:

```typescript
// this same method will work with subscriptions as well.
serviceBusClient.createReceiver(<queue>, {
subQueue: "deadLetter"
});
```

- Renames:
- The `ServiceBusManagementClient` has been renamed to `ServiceBusAdministrationClient`. See
[Issue 11012](https://github.com/Azure/azure-sdk-for-js/issues/11012) for more details.
- All senders and receivers are now prefixed with `ServiceBus`: `ServiceBusSender`, `ServiceBusReceiver`, `ServiceBusSessionReceiver`
jongio marked this conversation as resolved.
Show resolved Hide resolved
- Lock duration fields for receivers have been renamed to apply to message locks and session locks:
- `maxMessageAutoRenewLockDurationInMs` to `maxAutoRenewLockDurationInMs`
- `autoRenewLockDurationInMs` -> `maxAutoRenewLockDurationInMs`
- `SessionReceiver.{get,set}State` has been renamed to `SessionReceiver.{get,set}SessionState`
- Administration API:
- Property `defaultMessageTtl` renamed to `defaultMessageTimeToLive` (Wherever applicable)
- `updatedAt` renamed to `modifiedAt`
- `ServiceBusManagementClientOptions` for `ServiceBusManagementClient` is replaced by `PipelineOptions` from `@azure/core-http`
- `AuthorizationRule.accessRights` type has been changed to be a string union with the available rights.

#### New Features in @azure/[email protected]

- Support using the SharedAccessSignature from the connection string.
jongio marked this conversation as resolved.
Show resolved Hide resolved
([PR 10951](https://github.com/Azure/azure-sdk-for-js/pull/10951)).
- Added a new field `amqpAnnotatedMessage` to the received message which will hold the received
message in its raw form, complete with all parts of the message as per the [AMQP spec](https://www.amqp.org/sites/amqp.org/files/amqp.pdf).
- Added `ServiceBusAdministrationClient.ruleExists()`

jongio marked this conversation as resolved.
Show resolved Hide resolved

### Azure Tables

We're releasing the first beta version of the new Azure Tables client, following our [guidelines](https://azure.github.io/azure-sdk/typescript_introduction.html) which ensures it is idiomatic, consistent, and diagnosable. It supports essential operations of the service, such as creating and deleting tables, as well as querying, creating, reading, updating and deleting entities.
jongio marked this conversation as resolved.
Show resolved Hide resolved

#### Azure Tables [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/tables/data-tables/CHANGELOG.md)

##### New Features on @azure/[email protected]

- First beta release of this new package.
- Provides client API to interact with the Azure Tables service
- [Readme](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/tables/data-tables/README.md)
jongio marked this conversation as resolved.
Show resolved Hide resolved

ljian3377 marked this conversation as resolved.
Show resolved Hide resolved

ljian3377 marked this conversation as resolved.
Show resolved Hide resolved
## Latest Releases
sadasant marked this conversation as resolved.
Show resolved Hide resolved
sadasant marked this conversation as resolved.
Show resolved Hide resolved

sadasant marked this conversation as resolved.
Show resolved Hide resolved
sadasant marked this conversation as resolved.
Show resolved Hide resolved
Expand Down