Skip to content

Commit

Permalink
New aka.ms/azsdk links (#9034)
Browse files Browse the repository at this point in the history
* Duplicated ThirdPartyNotices in eventhub

* no more https://azure.github.io/azure-sdk-for-js links

* other link fixes

* new aka.ms links

* docs/<service> to <service>/docs, as agreed upon over Teams

* Changed https://aka.ms/azure-sdk-preview1-js to https://aka.ms/azsdk/releases/July2019Preview

* removed the versions

* Update README.md

* lowercase july2019preview

* lowercase july2019preview
  • Loading branch information
sadasant authored Jun 8, 2020
1 parent e9c3829 commit a195ac0
Show file tree
Hide file tree
Showing 20 changed files with 115 additions and 152 deletions.
2 changes: 1 addition & 1 deletion sdk/cosmosdb/cosmos/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ Fixes broken session tokens in the browser. Cosmos uses file system friendly bas
- User cancelable requests
- Update to the latest Cosmos REST API version where [all containers have unlimited scale](https://docs.microsoft.com/en-us/azure/cosmos-db/migrate-containers-partitioned-to-nonpartitioned)
- Make it easier to use Cosmos from the browser
- Better align with the new [Azure JS SDK guidlines](https://azuresdkspecs.z5.web.core.windows.net/TypeScriptSpec.html)
- Better align with the new [Azure JS SDK guidlines](https://azure.github.io/azure-sdk/typescript_introduction.html)

### Migration Guide for Breaking Changes

Expand Down
15 changes: 0 additions & 15 deletions sdk/eventhub/ThirdPartyNotices

This file was deleted.

42 changes: 19 additions & 23 deletions sdk/eventhub/event-hubs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ changes between patch and minor updates.

- Adds a new attribute - `enqueuedTime` - to the links on "Azure.EventHubs.process" spans.
`enqueuedTime` maps to the enqueuedTimeUtc field from received events, represented as
Unix epoch time in millseconds.
Unix epoch time in milliseconds.
Address [#7112](https://github.com/Azure/azure-sdk-for-js/issues/7112)

## 5.2.0 (2020-05-05)
Expand Down Expand Up @@ -193,36 +193,32 @@ Construction of both objects is the same as it was for the previous client.

Version 5.0.0-preview.1 is a preview of our efforts to create a client library that is user friendly and
idiomatic to the Javascript ecosystem. The reasons for most of the changes in this update can be found in the
[Azure SDK Design Guidelines for TypeScript](https://azuresdkspecs.z5.web.core.windows.net/TypeScriptSpec.html).
For more information, please visit https://aka.ms/azure-sdk-preview1-js
[Azure SDK Design Guidelines for TypeScript](https://azure.github.io/azure-sdk/typescript_introduction.html).
For more information, please visit https://aka.ms/azsdk/releases/july2019preview

### Breaking changes

- Creating an instance of [EventHubClient](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubclient.html)
is now done using construtor overloads instead of static helpers. - If you previously used the `createFromTokenProvider` static helper to provide your own custom token provider,
you will now need to update the provider to follow the new `TokenCredential` interface instead. - If you previously used the `@azure/ms-rest-nodeauth` library to provide AAD credentials, you will now need to use the new
[@azure/identity](https://www.npmjs.com/package/@azure/identity) library instead.
- The send methods are moved from the `EventHubClient` class to the new [EventHubProducer](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubproducer.html) class.
- Use the [createProducer()](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubclient.html#createproducer)
function on the `EventHubClient` to create an instance of a `EventHubProducer`.
- Creating an instance of `EventHubClient` is now done using constructor overloads instead of static helpers.
- If you previously used the `createFromTokenProvider` static helper to provide your own custom token provider,
you will now need to update the provider to follow the new `TokenCredential` interface instead.
- If you previously used the `@azure/ms-rest-nodeauth` library to provide AAD credentials, you will now need to use the new
[@azure/identity](https://www.npmjs.com/package/@azure/identity) library instead.
- The send methods are moved from the `EventHubClient` class to the new `EventHubProducer` class.
- Use the `createProducer()` function on the `EventHubClient` to create an instance of a `EventHubProducer`.
- Each producer represents a dedicated AMQP sender link to Azure Event Hubs.
- The [EventData](https://azure.github.io/azure-sdk-for-js/event-hubs/interfaces/eventdata.html) type used for
the data being sent only supports a `body` for the content being sent and a
- The `EventData` type used for the data being sent only supports a `body` for the content being sent and a
`properties` bag to hold any custom metadata you want to send. The properties corresponding to a received event are
removed from this type and a separate type [ReceivedEventData](https://azure.github.io/azure-sdk-for-js/event-hubs/interfaces/receivedeventdata.html)
is used for received events.
- The receive methods are moved from the `EventHubClient` class to the new [EventHubConsumer](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubconsumer.html) class.
- Use the [createConsumer()](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubclient.html#createconsumer)
function on the `EventHubClient` to create an instance of a `EventHubConsumer`.
removed from this type and a separate type ReceivedEventData is used for received events.
- The receive methods are moved from the `EventHubClient` class to the new `EventHubConsumer` class.
- Use the `createConsumer()` function on the `EventHubClient` to create an instance of a `EventHubConsumer`.
- Each consumer represents a dedicated AMQP receiver link to Azure Event Hubs based
on the flavor of receive function being used i.e `receiveBatch()` that receives events in a batch vs `receive()` that provides
a streaming receiver.
- The static methods `EventPosition.fromStart()` and `EventPosition.fromEnd()` are renamed to `EventPosition.earliest()` and `EventPosition.latest()` respectively.
- Inspecting Event Hub
- The methods `getHubRuntimeInformation()` and `getPartitionInformation()` on the `EventHubClient` are renamed to
[getProperties()](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubclient.html#getproperties) and
[getPartitionProperties()](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubclient.html#getpartitionproperties)
respectively. Please refer to the return types of these functions to ensure you are using the right property names.
`getProperties()` and `getPartitionProperties()` respectively. Please refer to the return types of these functions
to ensure you are using the right property names.

### New features

Expand All @@ -231,12 +227,12 @@ For more information, please visit https://aka.ms/azure-sdk-preview1-js
- You can now pass an abort signal to any of the async operations. This signal can be used to cancel such operations. Use
the package [@azure/abort-controller](https://www.npmjs.com/package/@azure/abort-controller) to create such abort signals.
- An async iterator is now available to receive events after you create an instance of `EventHubConsumer`. Use the function
[getEventIterator()](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubconsumer.html#geteventiterator) on the consumer to get a `AsyncIterableIterator` which you can then use in a loop or use it's `next()` function to receive events.
`getEventIterator()` on the consumer to get a `AsyncIterableIterator` which you can then use in a loop or use it's `next()`
function to receive events.

### Next Steps

- Refer to the [API reference documentation](https://azure.github.io/azure-sdk-for-js/event-hubs/index.html) to get
an overview of the entire API surface.
- Refer to the `API reference documentation` to get an overview of the entire API surface.
- Refer to our [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs/samples) to understand the usage of the new APIs.

## 2.1.0 (2019-06-10)
Expand Down
2 changes: 1 addition & 1 deletion sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

- This release is a preview of our efforts to create a client library that is user friendly and
idiomatic to the JavaScript ecosystem. The reasons for most of the changes in this update can be found in the
[Azure SDK Design Guidelines for TypeScript](https://azuresdkspecs.z5.web.core.windows.net/TypeScriptSpec.html).
[Azure SDK Design Guidelines for TypeScript](https://azure.github.io/azure-sdk/typescript_introduction.html).
- Differences from previous public package `@azure/cognitiveservices-formrecognizer`
- Package name changed from `@azure/cognitiveservices-formrecognizer` to `@azure/ai-form-recognizer`.
- Package targets version `2.0` of the service API.
2 changes: 1 addition & 1 deletion sdk/formrecognizer/ai-form-recognizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ from form documents. It includes the following main functionalities:

[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/formrecognizer/ai-form-recognizer/) |
[Package (NPM)](https://www.npmjs.com/package/@azure/ai-form-recognizer) |
[API reference documentation](https://aka.ms/azsdk-js-formrecognizer-ref-docs) |
[API reference documentation](https://aka.ms/azsdk/js/formrecognizer/docs) |
[Product documentation](https://docs.microsoft.com/azure/cognitive-services/form-recognizer/) |
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/formrecognizer/ai-form-recognizer/samples)

Expand Down
32 changes: 16 additions & 16 deletions sdk/identity/identity/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## 1.1.0-preview.4 (Unreleased)


## 1.1.0-preview.3 (2020-05-05)
- Add ability to read AZURE_AUTHORITY_HOST from environment ([PR #8226](https://github.com/Azure/azure-sdk-for-js/pull/8226) [PR #8343](https://github.com/Azure/azure-sdk-for-js/pull/8343))

- Add ability to read AZURE_AUTHORITY_HOST from environment ([PR #8226](https://github.com/Azure/azure-sdk-for-js/pull/8226) [PR #8343](https://github.com/Azure/azure-sdk-for-js/pull/8343))
- Update to OpenTelemetry 0.6 ([PR #7998](https://github.com/Azure/azure-sdk-for-js/pull/7998))
- Set expires_on at a higher precedence for IMDS ([PR #8591](https://github.com/Azure/azure-sdk-for-js/pull/8591))

Expand Down Expand Up @@ -50,7 +50,7 @@

## 1.0.0-preview.4 (2019-10-07)

- Introduced the [`AuthorizationCodeCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/authorizationcodecredential.html) for performing the [authorization code flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow) with AAD ([PR #5356](https://github.com/Azure/azure-sdk-for-js/pull/5356))
- Introduced the `AuthorizationCodeCredential` for performing the [authorization code flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow) with AAD ([PR #5356](https://github.com/Azure/azure-sdk-for-js/pull/5356))
- Fixed an issue preventing the `ManagedIdentityCredential` from working inside of Azure Function Apps ([PR #5144](https://github.com/Azure/azure-sdk-for-js/pull/5144))
- Added tracing to `IdentityClient` and credential implementations ([PR #5283](https://github.com/Azure/azure-sdk-for-js/pull/5283))
- Improved the exception message for `AggregateAuthenticationError` so that errors thrown from `DefaultAzureCredential` are now more actionable ([PR #5409](https://github.com/Azure/azure-sdk-for-js/pull/5409))
Expand All @@ -63,22 +63,22 @@
## 1.0.0-preview.2 (2019-08-05)

- Introduced the following credential types:
- [`DeviceCodeCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/devicecodecredential.html)
- [`InteractiveBrowserCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/interactivebrowsercredential.html)
- [`UsernamePasswordCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/usernamepasswordcredential.html)
- `DeviceCodeCredential`.
- `InteractiveBrowserCredential`.
- `UsernamePasswordCredential`.
- This library can now be used in the browser! The following credential types supported in browser builds:
- `ClientSecretCredential`
- `UsernamePasswordCredential`
- `InteractiveBrowserCredential`
- `ClientSecretCredential`.
- `UsernamePasswordCredential`.
- `InteractiveBrowserCredential`.

## 1.0.0-preview.1 (2019-06-27)

For release notes and more information please visit https://aka.ms/azure-sdk-preview1-js
For release notes and more information please visit https://aka.ms/azsdk/releases/july2019preview

- Introduced the following credential types:
- [`DefaultAzureCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/defaultazurecredential.html)
- [`EnvironmentCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/environmentcredential.html)
- [`ManagedIdentityCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/managedidentitycredential.html)
- [`ClientSecretCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/clientsecretcredential.html)
- [`ClientCertificateCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/clientcertificatecredential.html)
- [`ChainedTokenCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/chainedtokencredential.html)
- `DefaultAzureCredential`.
- `EnvironmentCredential`.
- `ManagedIdentityCredential`.
- `ClientSecretCredential`.
- `ClientCertificateCredential`.
- `ChainedTokenCredential`.
15 changes: 7 additions & 8 deletions sdk/identity/identity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ Authenticating as a managed identity requires no configuration, but does require

`DefaultAzureCredential` and `EnvironmentCredential` are configured for service principal authentication with these environment variables:

| variable name | value |
| ------------------------------- | ------------------------------------------------------------------------------------- |
| `AZURE_CLIENT_ID` | service principal's app id |
| `AZURE_TENANT_ID` | id of the principal's Azure Active Directory tenant |
| `AZURE_CLIENT_SECRET` | one of the service principal's client secrets (implies `ClientSecretCredential`) |
| variable name | value |
| ------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `AZURE_CLIENT_ID` | service principal's app id |
| `AZURE_TENANT_ID` | id of the principal's Azure Active Directory tenant |
| `AZURE_CLIENT_SECRET` | one of the service principal's client secrets (implies `ClientSecretCredential`) |
| `AZURE_CLIENT_CERTIFICATE_PATH` | path to a PEM-encoded certificate file including private key (implies `ClientCertificateCredential`) |
| `AZURE_USERNAME` | the username of a user in the tenant (implies `UsernamePasswordCredential`) |
| `AZURE_PASSWORD` | the password of the user specified in `AZURE_USERNAME` |
| `AZURE_USERNAME` | the username of a user in the tenant (implies `UsernamePasswordCredential`) |
| `AZURE_PASSWORD` | the password of the user specified in `AZURE_USERNAME` |

## Examples

Expand Down Expand Up @@ -149,5 +149,4 @@ If you'd like to contribute to this library, please read the [contributing guide
[8]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/interactivebrowsercredential.html
[9]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/usernamepasswordcredential.html


![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fidentity%2Fidentity%2FREADME.png)
2 changes: 1 addition & 1 deletion sdk/keyvault/keyvault-keys/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@
## 4.0.0-preview.1 (2019-06-28)

For release notes and more information please visit
https://aka.ms/azure-sdk-preview1-js
https://aka.ms/azsdk/releases/july2019preview
2 changes: 1 addition & 1 deletion sdk/keyvault/keyvault-secrets/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@
## 4.0.0-preview.1 (2019-06-28)

For release notes and more information please visit
https://aka.ms/azure-sdk-preview1-js
https://aka.ms/azsdk/releases/july2019preview
Loading

0 comments on commit a195ac0

Please sign in to comment.