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

New aka.ms/azsdk links #9034

Merged
merged 11 commits into from
Jun 8, 2020
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.

36 changes: 16 additions & 20 deletions sdk/eventhub/event-hubs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,36 +187,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).
[Azure SDK Design Guidelines for TypeScript](https://azure.github.io/azure-sdk/typescript_introduction.html).
For more information, please visit https://aka.ms/azure-sdk-preview1-js
Copy link
Member

Choose a reason for hiding this comment

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

This aka doesn't follow the pattern.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This isn't an aka. I thought that the TypeScript guidelines didn't need an aka.ms.

Copy link
Member

Choose a reason for hiding this comment

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

This: For more information, please visit https://aka.ms/azure-sdk-preview1-js

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have this as a question on the PR description:

To replace the TypeScript guidelines from their older link, https://azuresdkspecs.z5.web.core.windows.net/TypeScriptSpec.html, to their actual link https://azure.github.io/azure-sdk/typescript_introduction.html. Is this change correct? Should I make this another aka.ms link?

Copy link
Member

Choose a reason for hiding this comment

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

IMO, we don't need that whole line... "For more information, please visit https://aka.ms/azure-sdk-preview1-js"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jongio I just saw this:

This: For more information, please visit https://aka.ms/azure-sdk-preview1-js

I think GitHub wasn't loading on me earlier! I understand your point now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What about changing these https://aka.ms/azure-sdk-preview1-js to something like https://aka.ms/azsdk/releases/July2019Preview ? Otherwise some changelogs are left with empty entries.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've done this preemptively. Hoping this help us save some time.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good, we now track releases per month not as ordered sequence


### 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
- 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](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`.
- 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 @@ -225,12 +221,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 @@ -13,7 +13,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 @@ -11,7 +11,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/docs/formrecognizer) |
[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
26 changes: 13 additions & 13 deletions sdk/identity/identity/CHANGELOG.md
Original file line number Diff line number Diff line change
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

- 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`.
2 changes: 2 additions & 0 deletions sdk/identity/identity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ If this is your first time using `@azure/identity` or the Microsoft identity pla

Azure Identity offers a variety of credential classes that are accepted by Azure SDK data plane clients. Each client library documents its Azure Identity integration in its README and samples. Azure SDK management plane libraries (those starting with `@azure/arm-*`) do not accept these credentials.

> For outdated documentation links, please go instead to https://aka.ms/azsdk/js/docs/identity/1.0.0

Credentials differ mostly in configuration:

| credential class | identity | configuration |
Expand Down
2 changes: 1 addition & 1 deletion sdk/search/search-documents/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use the client library to:

[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/search/search/) |
[Package (NPM)](https://www.npmjs.com/package/@azure/search-documents) |
[API reference documentation](https://aka.ms/azsdk-js-search-ref-docs) |
[API reference documentation](https://aka.ms/azsdk/js/docs/search) |
sadasant marked this conversation as resolved.
Show resolved Hide resolved
[Product documentation](https://docs.microsoft.com/azure/search/) |
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples)

Expand Down
2 changes: 1 addition & 1 deletion sdk/search/search-documents/samples/javascript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ npx cross-env SEARCH_API_ENDPOINT="<endpoint>" SEARCH_API_KEY="<api key>" node r
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.

[readonly]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/readonlyQuery.js
[apiref]: https://aka.ms/azsdk-js-search-ref-docs
[apiref]: https://aka.ms/azsdk/js/docs/search
[search_resource]: https://docs.microsoft.com/azure/search/search-create-service-portal
[freesub]: https://azure.microsoft.com/free/
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/README.md
2 changes: 1 addition & 1 deletion sdk/search/search-documents/samples/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ npx cross-env SEARCH_API_ENDPOINT="<endpoint>" SEARCH_API_KEY="<api key>" node d
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.

[readonly]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/readonlyQuery.ts
[apiref]: https://aka.ms/azsdk-js-search-ref-docs
[apiref]: https://aka.ms/azsdk/js/docs/search
[search_resource]: https://docs.microsoft.com/azure/search/search-create-service-portal
[freesub]: https://azure.microsoft.com/free/
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/README.md
Expand Down
2 changes: 1 addition & 1 deletion sdk/servicebus/service-bus/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,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).

We also provide a migration guide for users familiar with the stable package that would like to try the preview: [migration guide to move from Service Bus V1 to Service Bus V7 Preview](https://github.com/azure/azure-sdk-for-js/blob/%40azure/service-bus_7.0.0-preview.1/sdk/servicebus/service-bus/migrationguide.md).

Expand Down
2 changes: 1 addition & 1 deletion sdk/servicebus/service-bus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ If you'd like to contribute to this library, please read the [contributing guide

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fservicebus%2Fservice-bus%2FREADME.png)

[apiref]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/index.html
[apiref]: https://aka.ms/azsdk/js/docs/service-bus/7.0.0-preview.2
[sbclient]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html
[sbclient_constructor]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#constructor
[sbclient_createsender]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createsender
Expand Down
2 changes: 1 addition & 1 deletion sdk/template/template/README-TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Use the client library to:

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

Expand Down
2 changes: 1 addition & 1 deletion sdk/textanalytics/ai-text-analytics/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,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-textanalytics`
- Package name changed from `@azure/cognitiveservices-textanalytics` to `@azure/ai-text-analytics`.
- Package targets version `3.0` of the service API.
Expand Down
2 changes: 1 addition & 1 deletion sdk/textanalytics/ai-text-analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Use the client library to:

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

Expand Down