From d6cd3d8003215eb8026eae93e38b321463344c1f Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Wed, 20 May 2020 17:47:33 +0000 Subject: [PATCH 01/10] Duplicated ThirdPartyNotices in eventhub --- sdk/eventhub/ThirdPartyNotices | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 sdk/eventhub/ThirdPartyNotices diff --git a/sdk/eventhub/ThirdPartyNotices b/sdk/eventhub/ThirdPartyNotices deleted file mode 100644 index a0bd09d68f8e..000000000000 --- a/sdk/eventhub/ThirdPartyNotices +++ /dev/null @@ -1,15 +0,0 @@ -##Legal Notices -Microsoft and any contributors grant you a license to the Microsoft documentation and other content -in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), -see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the -[LICENSE-CODE](LICENSE-CODE) file. - -Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation -may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. -The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. -Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653. - -Privacy information can be found at https://privacy.microsoft.com/en-us/ - -Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, -or trademarks, whether by implication, estoppel or otherwise. \ No newline at end of file From 49066cc3158f26a7ce11e19781ebfbc0005732b2 Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Wed, 20 May 2020 18:28:14 +0000 Subject: [PATCH 02/10] no more https://azure.github.io/azure-sdk-for-js links --- sdk/eventhub/event-hubs/CHANGELOG.md | 34 ++++++++++++---------------- sdk/identity/identity/CHANGELOG.md | 26 ++++++++++----------- 2 files changed, 28 insertions(+), 32 deletions(-) diff --git a/sdk/eventhub/event-hubs/CHANGELOG.md b/sdk/eventhub/event-hubs/CHANGELOG.md index 080b5ed54afd..8cfd08096c04 100644 --- a/sdk/eventhub/event-hubs/CHANGELOG.md +++ b/sdk/eventhub/event-hubs/CHANGELOG.md @@ -192,31 +192,27 @@ For more information, please visit https://aka.ms/azure-sdk-preview1-js ### 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 @@ -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) diff --git a/sdk/identity/identity/CHANGELOG.md b/sdk/identity/identity/CHANGELOG.md index 59f4f8d28c35..a668df78843c 100644 --- a/sdk/identity/identity/CHANGELOG.md +++ b/sdk/identity/identity/CHANGELOG.md @@ -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)) @@ -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`. From 4bcb43fff7ca1bf0fd0b84f68c719388e6cbf978 Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Wed, 20 May 2020 18:43:48 +0000 Subject: [PATCH 03/10] other link fixes --- sdk/cosmosdb/cosmos/CHANGELOG.md | 2 +- sdk/eventhub/event-hubs/CHANGELOG.md | 2 +- .../ai-form-recognizer/CHANGELOG.md | 2 +- sdk/identity/identity/README.md | 18 ++++++------- sdk/servicebus/service-bus/CHANGELOG.md | 2 +- sdk/servicebus/service-bus/README.md | 26 +++++++++---------- .../ai-text-analytics/CHANGELOG.md | 2 +- 7 files changed, 27 insertions(+), 27 deletions(-) diff --git a/sdk/cosmosdb/cosmos/CHANGELOG.md b/sdk/cosmosdb/cosmos/CHANGELOG.md index bcce9432ff49..dbea2a941172 100644 --- a/sdk/cosmosdb/cosmos/CHANGELOG.md +++ b/sdk/cosmosdb/cosmos/CHANGELOG.md @@ -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 diff --git a/sdk/eventhub/event-hubs/CHANGELOG.md b/sdk/eventhub/event-hubs/CHANGELOG.md index 8cfd08096c04..5ec8c7ca5997 100644 --- a/sdk/eventhub/event-hubs/CHANGELOG.md +++ b/sdk/eventhub/event-hubs/CHANGELOG.md @@ -187,7 +187,7 @@ 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 ### Breaking changes diff --git a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md index 8e756082c36b..e3f7a814d7fb 100644 --- a/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md +++ b/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md @@ -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. diff --git a/sdk/identity/identity/README.md b/sdk/identity/identity/README.md index 4051af5961f0..5a03d4f19306 100644 --- a/sdk/identity/identity/README.md +++ b/sdk/identity/identity/README.md @@ -139,15 +139,15 @@ If you encounter bugs or have suggestions, please [open an issue](https://github If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code. -[1]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/defaultazurecredential.html -[2]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/managedidentitycredential.html -[3]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/environmentcredential.html -[4]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/clientsecretcredential.html -[5]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/clientcertificatecredential.html -[6]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/devicecodecredential.html -[7]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/authorizationcodecredential.html -[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 +[1]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/defaultazurecredential.html +[2]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/managedidentitycredential.html +[3]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/environmentcredential.html +[4]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/clientsecretcredential.html +[5]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/clientcertificatecredential.html +[6]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/devicecodecredential.html +[7]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/authorizationcodecredential.html +[8]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/interactivebrowsercredential.html +[9]: https://aka.ms/azsdk/js/docs/ref/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) diff --git a/sdk/servicebus/service-bus/CHANGELOG.md b/sdk/servicebus/service-bus/CHANGELOG.md index 8364539b86b5..4df9fd5477db 100644 --- a/sdk/servicebus/service-bus/CHANGELOG.md +++ b/sdk/servicebus/service-bus/CHANGELOG.md @@ -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). diff --git a/sdk/servicebus/service-bus/README.md b/sdk/servicebus/service-bus/README.md index 86d0ef2a6470..a4095303d2c8 100644 --- a/sdk/servicebus/service-bus/README.md +++ b/sdk/servicebus/service-bus/README.md @@ -301,19 +301,19 @@ 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 -[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 -[sbclient_createreceiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createreceiver -[sbclient_createsessionreceiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createsessionreceiver -[sender]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/sender.html -[sender_send]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/sender.html#send -[receiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html -[receiverreceivebatch]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#receivebatch -[receiver_subscribe]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#subscribe -[receiver_getmessageiterator]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#getmessageiterator -[sessionreceiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/sessionreceiver.html +[apiref]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/index.html +[sbclient]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html +[sbclient_constructor]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#constructor +[sbclient_createsender]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createsender +[sbclient_createreceiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createreceiver +[sbclient_createsessionreceiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createsessionreceiver +[sender]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/sender.html +[sender_send]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/sender.html#send +[receiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html +[receiverreceivebatch]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#receivebatch +[receiver_subscribe]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#subscribe +[receiver_getmessageiterator]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#getmessageiterator +[sessionreceiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/sessionreceiver.html [migrationguide]: https://github.com/Azure/azure-sdk-for-js/blob/%40azure/service-bus_7.0.0-preview.2/sdk/servicebus/service-bus/migrationguide.md [docsms_messagesessions]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-sessions [docsms_messagesessions_fifo]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-sessions#first-in-first-out-fifo-pattern diff --git a/sdk/textanalytics/ai-text-analytics/CHANGELOG.md b/sdk/textanalytics/ai-text-analytics/CHANGELOG.md index e71da276e008..5dc48001e5e6 100644 --- a/sdk/textanalytics/ai-text-analytics/CHANGELOG.md +++ b/sdk/textanalytics/ai-text-analytics/CHANGELOG.md @@ -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. From 7db1a16a67aef0acc094ab48480663850ec95d8c Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Thu, 21 May 2020 23:18:49 +0000 Subject: [PATCH 04/10] new aka.ms links --- .../ai-form-recognizer/README.md | 2 +- sdk/identity/identity/README.md | 20 +++++++------- sdk/search/search-documents/README.md | 2 +- .../samples/javascript/README.md | 2 +- .../samples/typescript/README.md | 2 +- sdk/servicebus/service-bus/README.md | 26 +++++++++---------- sdk/template/template/README-TEMPLATE.md | 2 +- sdk/textanalytics/ai-text-analytics/README.md | 2 +- 8 files changed, 30 insertions(+), 28 deletions(-) diff --git a/sdk/formrecognizer/ai-form-recognizer/README.md b/sdk/formrecognizer/ai-form-recognizer/README.md index d551568e2822..6b0f14d74b61 100644 --- a/sdk/formrecognizer/ai-form-recognizer/README.md +++ b/sdk/formrecognizer/ai-form-recognizer/README.md @@ -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) diff --git a/sdk/identity/identity/README.md b/sdk/identity/identity/README.md index 5a03d4f19306..5e6340c0f801 100644 --- a/sdk/identity/identity/README.md +++ b/sdk/identity/identity/README.md @@ -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 | @@ -139,15 +141,15 @@ If you encounter bugs or have suggestions, please [open an issue](https://github If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code. -[1]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/defaultazurecredential.html -[2]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/managedidentitycredential.html -[3]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/environmentcredential.html -[4]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/clientsecretcredential.html -[5]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/clientcertificatecredential.html -[6]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/devicecodecredential.html -[7]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/authorizationcodecredential.html -[8]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/interactivebrowsercredential.html -[9]: https://aka.ms/azsdk/js/docs/ref/azure-identity/1.0.0/classes/usernamepasswordcredential.html +[1]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/defaultazurecredential.html +[2]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/managedidentitycredential.html +[3]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/environmentcredential.html +[4]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/clientsecretcredential.html +[5]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/clientcertificatecredential.html +[6]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/devicecodecredential.html +[7]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/1.0.0/classes/authorizationcodecredential.html +[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) diff --git a/sdk/search/search-documents/README.md b/sdk/search/search-documents/README.md index e66ba86e56ab..045a8bbc0479 100644 --- a/sdk/search/search-documents/README.md +++ b/sdk/search/search-documents/README.md @@ -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) | [Product documentation](https://docs.microsoft.com/azure/search/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples) diff --git a/sdk/search/search-documents/samples/javascript/README.md b/sdk/search/search-documents/samples/javascript/README.md index 0bf5d79033ce..3d48f0788bf6 100644 --- a/sdk/search/search-documents/samples/javascript/README.md +++ b/sdk/search/search-documents/samples/javascript/README.md @@ -43,7 +43,7 @@ npx cross-env SEARCH_API_ENDPOINT="" SEARCH_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 diff --git a/sdk/search/search-documents/samples/typescript/README.md b/sdk/search/search-documents/samples/typescript/README.md index e0457262b50f..1fbc90faaf5a 100644 --- a/sdk/search/search-documents/samples/typescript/README.md +++ b/sdk/search/search-documents/samples/typescript/README.md @@ -55,7 +55,7 @@ npx cross-env SEARCH_API_ENDPOINT="" SEARCH_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 diff --git a/sdk/servicebus/service-bus/README.md b/sdk/servicebus/service-bus/README.md index a4095303d2c8..cde1669b5087 100644 --- a/sdk/servicebus/service-bus/README.md +++ b/sdk/servicebus/service-bus/README.md @@ -301,19 +301,19 @@ 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://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/index.html -[sbclient]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html -[sbclient_constructor]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#constructor -[sbclient_createsender]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createsender -[sbclient_createreceiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createreceiver -[sbclient_createsessionreceiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createsessionreceiver -[sender]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/sender.html -[sender_send]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/sender.html#send -[receiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html -[receiverreceivebatch]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#receivebatch -[receiver_subscribe]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#subscribe -[receiver_getmessageiterator]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#getmessageiterator -[sessionreceiver]: https://aka.ms/azsdk/js/docs/ref/azure-service-bus/7.0.0-preview.2/interfaces/sessionreceiver.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 +[sbclient_createreceiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createreceiver +[sbclient_createsessionreceiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/classes/servicebusclient.html#createsessionreceiver +[sender]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/sender.html +[sender_send]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/sender.html#send +[receiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html +[receiverreceivebatch]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#receivebatch +[receiver_subscribe]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#subscribe +[receiver_getmessageiterator]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/receiver.html#getmessageiterator +[sessionreceiver]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.2/interfaces/sessionreceiver.html [migrationguide]: https://github.com/Azure/azure-sdk-for-js/blob/%40azure/service-bus_7.0.0-preview.2/sdk/servicebus/service-bus/migrationguide.md [docsms_messagesessions]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-sessions [docsms_messagesessions_fifo]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-sessions#first-in-first-out-fifo-pattern diff --git a/sdk/template/template/README-TEMPLATE.md b/sdk/template/template/README-TEMPLATE.md index 1de2920bcb20..1811e5d84d42 100644 --- a/sdk/template/template/README-TEMPLATE.md +++ b/sdk/template/template/README-TEMPLATE.md @@ -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) diff --git a/sdk/textanalytics/ai-text-analytics/README.md b/sdk/textanalytics/ai-text-analytics/README.md index a59ee1532a56..ffe68fc03cfc 100644 --- a/sdk/textanalytics/ai-text-analytics/README.md +++ b/sdk/textanalytics/ai-text-analytics/README.md @@ -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) From 694286004ea5e568d4ffa40f2934dd5d20ea3612 Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Sat, 30 May 2020 01:15:29 +0000 Subject: [PATCH 05/10] docs/ to /docs, as agreed upon over Teams --- .../ai-form-recognizer/README.md | 2 +- sdk/identity/identity/README.md | 17 +++-- sdk/search/search-documents/README.md | 65 ++++++++++--------- .../samples/javascript/README.md | 2 +- .../samples/typescript/README.md | 2 +- sdk/servicebus/service-bus/README.md | 16 ++--- sdk/template/template/README-TEMPLATE.md | 2 +- sdk/textanalytics/ai-text-analytics/README.md | 59 ++++++----------- 8 files changed, 74 insertions(+), 91 deletions(-) diff --git a/sdk/formrecognizer/ai-form-recognizer/README.md b/sdk/formrecognizer/ai-form-recognizer/README.md index 6b0f14d74b61..a516a194cd1c 100644 --- a/sdk/formrecognizer/ai-form-recognizer/README.md +++ b/sdk/formrecognizer/ai-form-recognizer/README.md @@ -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/docs/formrecognizer) | +[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) diff --git a/sdk/identity/identity/README.md b/sdk/identity/identity/README.md index 5e6340c0f801..b7e1207f65e0 100644 --- a/sdk/identity/identity/README.md +++ b/sdk/identity/identity/README.md @@ -28,7 +28,7 @@ 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 +> For outdated documentation links, please go instead to https://aka.ms/azsdk/js/identity/docs/1.0.0 Credentials differ mostly in configuration: @@ -56,14 +56,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 @@ -151,5 +151,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) diff --git a/sdk/search/search-documents/README.md b/sdk/search/search-documents/README.md index 045a8bbc0479..0baf28f5db10 100644 --- a/sdk/search/search-documents/README.md +++ b/sdk/search/search-documents/README.md @@ -19,11 +19,12 @@ 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/docs/search) | +[API reference documentation](https://aka.ms/azsdk/js/search/docs) | [Product documentation](https://docs.microsoft.com/azure/search/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples) ## Getting started + ### Install the `@azure/search-documents` package ```bash @@ -44,7 +45,6 @@ az search service create --resource-group --name ", new AzureKeyCredenti ``` ### Send your first search query -To get running immediately, we're going to connect to a well known sandbox Search service provided by Microsoft. This means you do not need an Azure subscription or Azure Cognitive Search service to try out this query. + +To get running immediately, we're going to connect to a well known sandbox Search service provided by Microsoft. This means you do not need an Azure subscription or Azure Cognitive Search service to try out this query. ```js const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); @@ -113,13 +114,14 @@ Azure Cognitive Search has the concepts of search services and indexes and docum There are several types of operations that can be executed against the service: -- [Index management operations](https://docs.microsoft.com/rest/api/searchservice/index-operations). Create, delete, update, or configure a search index. -- [Document operations](https://docs.microsoft.com/rest/api/searchservice/document-operations). Add, update, or delete documents in the index, query the index, or look up specific documents by ID. -- [Indexer operations](https://docs.microsoft.com/rest/api/searchservice/indexer-operations). Automate aspects of an indexing operation by configuring a data source and an indexer that you can schedule or run on demand. This feature is supported for a limited number of data source types. -- [Skillset operations](https://docs.microsoft.com/rest/api/searchservice/skillset-operations). Part of a cognitive search workload, a skillset defines a series of enrichment processing steps. A skillset is consumed by an indexer. -- [Synonym map operations](https://docs.microsoft.com/rest/api/searchservice/synonym-map-operations). A synonym map is a service-level resource that contains user-defined synonyms. This resource is maintained independently from search indexes. Once uploaded, you can point any searchable field to the synonym map (one per field). +- [Index management operations](https://docs.microsoft.com/rest/api/searchservice/index-operations). Create, delete, update, or configure a search index. +- [Document operations](https://docs.microsoft.com/rest/api/searchservice/document-operations). Add, update, or delete documents in the index, query the index, or look up specific documents by ID. +- [Indexer operations](https://docs.microsoft.com/rest/api/searchservice/indexer-operations). Automate aspects of an indexing operation by configuring a data source and an indexer that you can schedule or run on demand. This feature is supported for a limited number of data source types. +- [Skillset operations](https://docs.microsoft.com/rest/api/searchservice/skillset-operations). Part of a cognitive search workload, a skillset defines a series of enrichment processing steps. A skillset is consumed by an indexer. +- [Synonym map operations](https://docs.microsoft.com/rest/api/searchservice/synonym-map-operations). A synonym map is a service-level resource that contains user-defined synonyms. This resource is maintained independently from search indexes. Once uploaded, you can point any searchable field to the synonym map (one per field). ## TypeScript/JavaScript specific concepts + ### SearchIndexClient `SearchIndexClient` provides methods for working with documents in an index. Its methods allow you to query, upload, update, and delete documents. It also has methods for building auto-completion and search suggestion experiences based on partial queries. @@ -164,19 +166,19 @@ async function main() { { type: "Edm.String", name: "id", - key: true + key: true, }, { type: "Edm.Double", name: "awesomenessLevel", sortable: true, filterable: true, - facetable: true + facetable: true, }, { type: "Edm.String", name: "description", - searchable: true + searchable: true, }, { type: "Edm.ComplexType", @@ -185,16 +187,16 @@ async function main() { { type: "Collection(Edm.String)", name: "tags", - searchable: true - } - ] + searchable: true, + }, + ], }, { type: "Edm.Int32", name: "hiddenWeight", - hidden: true - } - ] + hidden: true, + }, + ], }); console.log(result); @@ -221,7 +223,7 @@ async function main() { // JSON objects matching the shape of the client's index {}, {}, - {} + {}, ]); for (const result of uploadResult.results) { console.log(`Uploaded ${result.key}; succeeded? ${result.succeeded}`); @@ -252,7 +254,6 @@ async function main() { main(); ``` - ### Perform a search on documents To list all results of a particular query, you can use `search` with a search string that uses [simple query syntax](https://docs.microsoft.com/azure/search/query-simple-syntax): @@ -291,7 +292,7 @@ async function main() { const searchResults = await client.search({ searchText: 'Category:budget AND "recently renovated"^3', queryType: "full", - searchMode: "all" + searchMode: "all", }); for await (const result of searchResults.results) { console.log(result); @@ -329,7 +330,7 @@ async function main() { searchText: "wifi -luxury", // Only fields in Hotel can be added to this array. // TS will complain if one is misspelled. - select: ["HotelId", "HotelName", "Rating"] + select: ["HotelId", "HotelName", "Rating"], }); for await (const result of searchResults.results) { @@ -362,7 +363,7 @@ async function main() { searchText: "WiFi", filter: odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`, orderBy: ["Rating desc"], - select: ["HotelId", "HotelName", "Rating"] + select: ["HotelId", "HotelName", "Rating"], }); for await (const result of searchResults.results) { // Each result will have "HotelId", "HotelName", and "Rating" @@ -390,7 +391,7 @@ const client = new SearchIndexClient( async function main() { const searchResults = await client.search({ searchText: "WiFi", - facets: ["Category,count:3,sort:count", "Rooms/BaseRate,interval:100"] + facets: ["Category,count:3,sort:count", "Rooms/BaseRate,interval:100"], }); console.log(searchResults.facets); // Output will look like: @@ -435,7 +436,7 @@ async function main() { select: ["HotelId", "HotelName"], highlightPreTag: "", highlightPostTag: "", - top: 3 + top: 3, }); for (const result of suggestResult.results) { @@ -464,7 +465,7 @@ const client = new SearchIndexClient( async function main() { const autocompleteResult = await client.autocomplete({ searchText: "de", - suggesterName: "sg" + suggesterName: "sg", }); for (const result of autocompleteResult.results || []) { @@ -485,7 +486,7 @@ In order to ensure that analysis is configured correctly, developers can directl const { SearchServiceClient, AzureKeyCredential, - KnownTokenFilterNames + KnownTokenFilterNames, } = require("@azure/search-documents"); const client = new SearchServiceClient("", new AzureKeyCredential("")); @@ -495,24 +496,24 @@ async function main() { index.tokenizers.push({ name: "example-tokenizer", odatatype: "#Microsoft.Azure.Search.StandardTokenizerV2", - maxTokenLength: 125 + maxTokenLength: 125, }); index.charFilters.push({ name: "example-char-filter", odatatype: "#Microsoft.Azure.Search.MappingCharFilter", - mappings: ["MSFT=>Microsoft"] + mappings: ["MSFT=>Microsoft"], }); index.tokenFilters.push({ name: "example-token-filter", odatatype: "#Microsoft.Azure.Search.StopwordsTokenFilter", - stopwords: ["xyzzy"] + stopwords: ["xyzzy"], }); index.analyzers.push({ name: "example-analyzer", odatatype: "#Microsoft.Azure.Search.CustomAnalyzer", tokenizer: "example-tokenizer", charFilters: ["example-char-filter"], - tokenFilters: [KnownTokenFilterNames.Lowercase, "example-token-filter"] + tokenFilters: [KnownTokenFilterNames.Lowercase, "example-token-filter"], }); // Note adding this analyzer to an existing index will cause it to be unresponsive @@ -521,7 +522,7 @@ async function main() { const result = await client.analyzeText("example-index", { text: "MSFT is xyzzy Great!", - analyzer: "example-analyzer" + analyzer: "example-analyzer", }); console.log(result.tokens); diff --git a/sdk/search/search-documents/samples/javascript/README.md b/sdk/search/search-documents/samples/javascript/README.md index 3d48f0788bf6..2a89419b42ed 100644 --- a/sdk/search/search-documents/samples/javascript/README.md +++ b/sdk/search/search-documents/samples/javascript/README.md @@ -43,7 +43,7 @@ npx cross-env SEARCH_API_ENDPOINT="" SEARCH_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/docs/search +[apiref]: https://aka.ms/azsdk/js/search/docs [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 diff --git a/sdk/search/search-documents/samples/typescript/README.md b/sdk/search/search-documents/samples/typescript/README.md index 1fbc90faaf5a..26dd52e8181b 100644 --- a/sdk/search/search-documents/samples/typescript/README.md +++ b/sdk/search/search-documents/samples/typescript/README.md @@ -55,7 +55,7 @@ npx cross-env SEARCH_API_ENDPOINT="" SEARCH_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/docs/search +[apiref]: https://aka.ms/azsdk/js/search/docs [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 diff --git a/sdk/servicebus/service-bus/README.md b/sdk/servicebus/service-bus/README.md index cde1669b5087..4511b3ac5451 100644 --- a/sdk/servicebus/service-bus/README.md +++ b/sdk/servicebus/service-bus/README.md @@ -105,17 +105,17 @@ const sender = await serviceBusClient.createSender("my-queue"); // sending a single message await sender.send({ - body: "my-message-body" + body: "my-message-body", }); // sending multiple messages await sender.send([ { - body: "my-message-body" + body: "my-message-body", }, { - body: "another-message-body" - } + body: "another-message-body", + }, ]); ``` @@ -155,7 +155,7 @@ const myErrorHandler = async (error) => { }; receiver.subscribe({ processMessage: myMessageHandler, - processError: myErrorHandler + processError: myErrorHandler, }); ``` @@ -191,7 +191,7 @@ your message lands in the right session. const sender = await serviceBusClient.createSender("my-session-queue"); await sender.send({ body: "my-message-body", - sessionId: "my-session" + sessionId: "my-session", }); ``` @@ -216,7 +216,7 @@ There are two ways of choosing which session to open: ```javascript const receiver = await serviceBusClient.createSessionReceiver("my-session-queue", "peekLock", { - sessionId: "my-session" + sessionId: "my-session", }); ``` @@ -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://aka.ms/azsdk/js/docs/service-bus/7.0.0-preview.2 +[apiref]: https://aka.ms/azsdk/js/service-bus/docs/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 diff --git a/sdk/template/template/README-TEMPLATE.md b/sdk/template/template/README-TEMPLATE.md index 1811e5d84d42..d77bdad7a5c3 100644 --- a/sdk/template/template/README-TEMPLATE.md +++ b/sdk/template/template/README-TEMPLATE.md @@ -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/docs/textanalytics) | +[API reference documentation](https://aka.ms/azsdk/js/textanalytics/docs) | [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) diff --git a/sdk/textanalytics/ai-text-analytics/README.md b/sdk/textanalytics/ai-text-analytics/README.md index ffe68fc03cfc..212e1a1f8fac 100644 --- a/sdk/textanalytics/ai-text-analytics/README.md +++ b/sdk/textanalytics/ai-text-analytics/README.md @@ -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/docs/textanalytics) | +[API reference documentation](https://aka.ms/azsdk/js/textanalytics/docs) | [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) @@ -71,10 +71,7 @@ Once you have an API key and endpoint, you can use the `AzureKeyCredential` clas ```js const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics"); -const client = new TextAnalyticsClient( - "", - new AzureKeyCredential("") -); +const client = new TextAnalyticsClient("", new AzureKeyCredential("")); ``` #### Using an Azure Active Directory Credential @@ -113,7 +110,7 @@ For example, each document can be passed as a string in an array, e.g. const documents = [ "I hated the movie. It was so slow!", "The movie made it into my top ten favorites.", - "What a great movie!" + "What a great movie!", ]; ``` @@ -133,9 +130,9 @@ See [service limiations][data_limits] for the input, including document length l The return value corresponding to a single document is either a successful result or an error object. Each `TextAnalyticsClient` method returns a heterogeneous array of results and errors that correspond to the inputs by index. A text input and its result will have the same index in the input and result collections. The collection may also optionally include information about the input batch and how it was processed in the `statistics` field. -An __result__, such as `AnalyzeSentimentResult`, is the result of a Text Analytics operation, containing a prediction or predictions about a single text input. An operation's result type also may optionally include information about the input document and how it was processed. +An **result**, such as `AnalyzeSentimentResult`, is the result of a Text Analytics operation, containing a prediction or predictions about a single text input. An operation's result type also may optionally include information about the input document and how it was processed. -The __error__ object, `TextAnalyticsErrorResult`, indicates that the service encountered an error while processing the document and contains information about the error. +The **error** object, `TextAnalyticsErrorResult`, indicates that the service encountered an error while processing the document and contains information about the error. ### Document Error Handling @@ -148,7 +145,7 @@ const results = await client.analyzeSentiment(documents); const onlySuccessful = results.filter((result) => result.error === undefined); ``` -__Note__: TypeScript users can benefit from better type-checking of result and error objects if `compilerOptions.strictNullChecks` is set to `true` in their `tsconfig.json` configuration. For example: +**Note**: TypeScript users can benefit from better type-checking of result and error objects if `compilerOptions.strictNullChecks` is set to `true` in their `tsconfig.json` configuration. For example: ```typescript const [result] = await client.analyzeSentiment(["Hello world!"]); @@ -171,16 +168,13 @@ Analyze sentiment of text to determine if it is positive, negative, neutral, or ```javascript const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics"); -const client = new TextAnalyticsClient( - "", - new AzureKeyCredential("") -); +const client = new TextAnalyticsClient("", new AzureKeyCredential("")); const documents = [ "I did not like the restaurant. The food was too spicy.", "The restaurant was decorated beautifully. The atmosphere was unlike any other restaurant I've been to.", - "The food was yummy. :)" -] + "The food was yummy. :)", +]; async function main() { const results = await client.analyzeSentiment(documents); @@ -188,7 +182,7 @@ async function main() { for (const result of results) { if (result.error === undefined) { console.log("Overall sentiment:", result.sentiment); - console.log("Scores:", result.confidenceScores); + console.log("Scores:", result.confidenceScores); } else { console.error("Encountered an error:", result.error); } @@ -207,15 +201,12 @@ The `language` parameter is optional. If it is not specified, the default Englis ```javascript const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics"); -const client = new TextAnalyticsClient( - "", - new AzureKeyCredential("") -); +const client = new TextAnalyticsClient("", new AzureKeyCredential("")); const documents = [ "Microsoft was founded by Bill Gates and Paul Allen.", "Redmond is a city in King County, Washington, United States, located 15 miles east of Seattle.", - "Jeff bought three dozen eggs because there was a 50% discount." + "Jeff bought three dozen eggs because there was a 50% discount.", ]; async function main() { @@ -243,15 +234,12 @@ A "Linked" entity is one that exists in a knowledge base (such as Wikipedia). Th ```javascript const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics"); -const client = new TextAnalyticsClient( - "", - new AzureKeyCredential("") -); +const client = new TextAnalyticsClient("", new AzureKeyCredential("")); const documents = [ "Microsoft was founded by Bill Gates and Paul Allen.", "Easter Island, a Chilean territory, is a remote volcanic island in Polynesia.", - "I use Azure Functions to develop my product." + "I use Azure Functions to develop my product.", ]; async function main() { @@ -263,7 +251,7 @@ async function main() { for (const entity of result.entities) { console.log(entity.name, "(URL:", entity.url, ", Source:", entity.dataSource, ")"); for (const match of entity.matches) { - console.log(" Occurrence:", "\"" + match.text + "\"", "(Score:", match.score, ")"); + console.log(" Occurrence:", '"' + match.text + '"', "(Score:", match.score, ")"); } } } else { @@ -282,15 +270,12 @@ Key Phrase extraction identifies the main talking points in a document. For exam ```javascript const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics"); -const client = new TextAnalyticsClient( - "", - new AzureKeyCredential("") -); +const client = new TextAnalyticsClient("", new AzureKeyCredential("")); const documents = [ "Redmond is a city in King County, Washington, United States, located 15 miles east of Seattle.", "I need to take my cat to the veterinarian.", - "I will travel to South America in the summer." + "I will travel to South America in the summer.", ]; async function main() { @@ -299,7 +284,7 @@ async function main() { for (const result of results) { if (result.error === undefined) { console.log(" -- Extracted key phrases for input", result.id, "--"); - console.log(result.keyPhrases) + console.log(result.keyPhrases); } else { console.error("Encountered an error:", result.error); } @@ -318,15 +303,12 @@ The `countryHint` parameter is optional, but can assist the service in providing ```javascript const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics"); -const client = new TextAnalyticsClient( - "", - new AzureKeyCredential("") -); +const client = new TextAnalyticsClient("", new AzureKeyCredential("")); const documents = [ "This is written in English.", "Il documento scritto in italiano.", - "Dies ist in englischer Sprache verfasst." + "Dies ist in englischer Sprache verfasst.", ]; async function main() { @@ -396,3 +378,4 @@ If you'd like to contribute to this library, please read the [contributing guide [register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal [defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential [data_limits]: https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview#data-limits +``` From 17b3705fb7bd3c17a64f636d415eabe6c79aebcd Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Tue, 2 Jun 2020 12:25:29 +0000 Subject: [PATCH 06/10] Changed https://aka.ms/azure-sdk-preview1-js to https://aka.ms/azsdk/releases/July2019Preview --- sdk/eventhub/event-hubs/CHANGELOG.md | 6 +++--- sdk/identity/identity/CHANGELOG.md | 6 +++--- sdk/keyvault/keyvault-keys/CHANGELOG.md | 2 +- sdk/keyvault/keyvault-secrets/CHANGELOG.md | 2 +- sdk/storage/storage-blob/CHANGELOG.md | 2 +- sdk/storage/storage-file-share/CHANGELOG.md | 2 +- sdk/storage/storage-queue/CHANGELOG.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/sdk/eventhub/event-hubs/CHANGELOG.md b/sdk/eventhub/event-hubs/CHANGELOG.md index 5ec8c7ca5997..177b368bb33e 100644 --- a/sdk/eventhub/event-hubs/CHANGELOG.md +++ b/sdk/eventhub/event-hubs/CHANGELOG.md @@ -13,7 +13,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) @@ -188,7 +188,7 @@ 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://azure.github.io/azure-sdk/typescript_introduction.html). -For more information, please visit https://aka.ms/azure-sdk-preview1-js +For more information, please visit https://aka.ms/azsdk/releases/July2019Preview ### Breaking changes @@ -196,7 +196,7 @@ For more information, please visit https://aka.ms/azure-sdk-preview1-js - 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. + [@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. diff --git a/sdk/identity/identity/CHANGELOG.md b/sdk/identity/identity/CHANGELOG.md index a668df78843c..9a5969d5b616 100644 --- a/sdk/identity/identity/CHANGELOG.md +++ b/sdk/identity/identity/CHANGELOG.md @@ -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)) @@ -73,7 +73,7 @@ ## 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`. diff --git a/sdk/keyvault/keyvault-keys/CHANGELOG.md b/sdk/keyvault/keyvault-keys/CHANGELOG.md index a19b55d4723d..6468066e1411 100644 --- a/sdk/keyvault/keyvault-keys/CHANGELOG.md +++ b/sdk/keyvault/keyvault-keys/CHANGELOG.md @@ -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 diff --git a/sdk/keyvault/keyvault-secrets/CHANGELOG.md b/sdk/keyvault/keyvault-secrets/CHANGELOG.md index 5cef61c5d9ad..a95d3f5b8f19 100644 --- a/sdk/keyvault/keyvault-secrets/CHANGELOG.md +++ b/sdk/keyvault/keyvault-secrets/CHANGELOG.md @@ -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 diff --git a/sdk/storage/storage-blob/CHANGELOG.md b/sdk/storage/storage-blob/CHANGELOG.md index 79f80e115b68..d4a4d3a6f5ad 100644 --- a/sdk/storage/storage-blob/CHANGELOG.md +++ b/sdk/storage/storage-blob/CHANGELOG.md @@ -251,7 +251,7 @@ - `downloadToFile()` is added to `BlobClient`. - Exported `HttpRequestBody` type to allow implementation of a customized HTTP client. -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 ## 10.5.0 (2019.09) diff --git a/sdk/storage/storage-file-share/CHANGELOG.md b/sdk/storage/storage-file-share/CHANGELOG.md index 519a96a676fc..e1d99fe75867 100644 --- a/sdk/storage/storage-file-share/CHANGELOG.md +++ b/sdk/storage/storage-file-share/CHANGELOG.md @@ -185,7 +185,7 @@ - Request and response headers are now logged at INFO level, with sensitive data redacted. - `downloadToFile()` is added to `FileClient`. -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 ## 10.3.0 (2019.09) diff --git a/sdk/storage/storage-queue/CHANGELOG.md b/sdk/storage/storage-queue/CHANGELOG.md index 2eb062a5e947..261f1656d5a8 100644 --- a/sdk/storage/storage-queue/CHANGELOG.md +++ b/sdk/storage/storage-queue/CHANGELOG.md @@ -167,7 +167,7 @@ - Please refer to the `proxyAuth.ts` sample in the `samples/typescript` folder. - Request and response headers are now logged at INFO level, with sensitive data redacted. -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 ## 10.3.0 (2019.09) From ea09a3f3b770223947f35410b4c870c5b366a4c1 Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Tue, 2 Jun 2020 12:36:06 +0000 Subject: [PATCH 07/10] removed the versions --- sdk/identity/identity/README.md | 2 +- sdk/servicebus/service-bus/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/identity/identity/README.md b/sdk/identity/identity/README.md index b7e1207f65e0..5de9530c8c54 100644 --- a/sdk/identity/identity/README.md +++ b/sdk/identity/identity/README.md @@ -28,7 +28,7 @@ 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/identity/docs/1.0.0 +> For outdated documentation links, please go instead to https://aka.ms/azsdk/js/identity/docs Credentials differ mostly in configuration: diff --git a/sdk/servicebus/service-bus/README.md b/sdk/servicebus/service-bus/README.md index abf454893af4..cd22af300229 100644 --- a/sdk/servicebus/service-bus/README.md +++ b/sdk/servicebus/service-bus/README.md @@ -302,7 +302,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://aka.ms/azsdk/js/service-bus/docs/7.0.0-preview.2 +[apiref]: https://aka.ms/azsdk/js/service-bus/docs [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 From ad1104308b08017ec93eea1950aab91011829f4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Rodr=C3=ADguez?= Date: Thu, 4 Jun 2020 19:07:27 -0400 Subject: [PATCH 08/10] Update README.md --- sdk/identity/identity/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/sdk/identity/identity/README.md b/sdk/identity/identity/README.md index 5de9530c8c54..918f723612fd 100644 --- a/sdk/identity/identity/README.md +++ b/sdk/identity/identity/README.md @@ -28,8 +28,6 @@ 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/identity/docs - Credentials differ mostly in configuration: | credential class | identity | configuration | From 5a7f3622d3c8aaa746bb2dcf483381eed42f8799 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Rodr=C3=ADguez?= Date: Thu, 4 Jun 2020 19:09:40 -0400 Subject: [PATCH 09/10] lowercase july2019preview --- sdk/eventhub/event-hubs/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/eventhub/event-hubs/CHANGELOG.md b/sdk/eventhub/event-hubs/CHANGELOG.md index 177b368bb33e..7a7011fc2d53 100644 --- a/sdk/eventhub/event-hubs/CHANGELOG.md +++ b/sdk/eventhub/event-hubs/CHANGELOG.md @@ -188,7 +188,7 @@ 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://azure.github.io/azure-sdk/typescript_introduction.html). -For more information, please visit https://aka.ms/azsdk/releases/July2019Preview +For more information, please visit https://aka.ms/azsdk/releases/july2019preview ### Breaking changes From 79bc374de317e52cd5eadfd656bd7fad0162ca48 Mon Sep 17 00:00:00 2001 From: Daniel Rodriguez Date: Thu, 4 Jun 2020 23:12:55 +0000 Subject: [PATCH 10/10] lowercase july2019preview --- sdk/identity/identity/CHANGELOG.md | 2 +- sdk/keyvault/keyvault-keys/CHANGELOG.md | 2 +- sdk/keyvault/keyvault-secrets/CHANGELOG.md | 2 +- sdk/storage/storage-blob/CHANGELOG.md | 2 +- sdk/storage/storage-file-share/CHANGELOG.md | 2 +- sdk/storage/storage-queue/CHANGELOG.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sdk/identity/identity/CHANGELOG.md b/sdk/identity/identity/CHANGELOG.md index 9a5969d5b616..ef4c45153e25 100644 --- a/sdk/identity/identity/CHANGELOG.md +++ b/sdk/identity/identity/CHANGELOG.md @@ -73,7 +73,7 @@ ## 1.0.0-preview.1 (2019-06-27) -For release notes and more information please visit https://aka.ms/azsdk/releases/July2019Preview +For release notes and more information please visit https://aka.ms/azsdk/releases/july2019preview - Introduced the following credential types: - `DefaultAzureCredential`. diff --git a/sdk/keyvault/keyvault-keys/CHANGELOG.md b/sdk/keyvault/keyvault-keys/CHANGELOG.md index 6468066e1411..f7eb99830e4f 100644 --- a/sdk/keyvault/keyvault-keys/CHANGELOG.md +++ b/sdk/keyvault/keyvault-keys/CHANGELOG.md @@ -74,4 +74,4 @@ ## 4.0.0-preview.1 (2019-06-28) For release notes and more information please visit -https://aka.ms/azsdk/releases/July2019Preview +https://aka.ms/azsdk/releases/july2019preview diff --git a/sdk/keyvault/keyvault-secrets/CHANGELOG.md b/sdk/keyvault/keyvault-secrets/CHANGELOG.md index a95d3f5b8f19..5a1cfabdfa8e 100644 --- a/sdk/keyvault/keyvault-secrets/CHANGELOG.md +++ b/sdk/keyvault/keyvault-secrets/CHANGELOG.md @@ -72,4 +72,4 @@ ## 4.0.0-preview.1 (2019-06-28) For release notes and more information please visit -https://aka.ms/azsdk/releases/July2019Preview +https://aka.ms/azsdk/releases/july2019preview diff --git a/sdk/storage/storage-blob/CHANGELOG.md b/sdk/storage/storage-blob/CHANGELOG.md index d4a4d3a6f5ad..88ab22f6117e 100644 --- a/sdk/storage/storage-blob/CHANGELOG.md +++ b/sdk/storage/storage-blob/CHANGELOG.md @@ -251,7 +251,7 @@ - `downloadToFile()` is added to `BlobClient`. - Exported `HttpRequestBody` type to allow implementation of a customized HTTP client. -For release notes and more information please visit https://aka.ms/azsdk/releases/July2019Preview +For release notes and more information please visit https://aka.ms/azsdk/releases/july2019preview ## 10.5.0 (2019.09) diff --git a/sdk/storage/storage-file-share/CHANGELOG.md b/sdk/storage/storage-file-share/CHANGELOG.md index e1d99fe75867..f6f3c7f1b115 100644 --- a/sdk/storage/storage-file-share/CHANGELOG.md +++ b/sdk/storage/storage-file-share/CHANGELOG.md @@ -185,7 +185,7 @@ - Request and response headers are now logged at INFO level, with sensitive data redacted. - `downloadToFile()` is added to `FileClient`. -For release notes and more information please visit https://aka.ms/azsdk/releases/July2019Preview +For release notes and more information please visit https://aka.ms/azsdk/releases/july2019preview ## 10.3.0 (2019.09) diff --git a/sdk/storage/storage-queue/CHANGELOG.md b/sdk/storage/storage-queue/CHANGELOG.md index 261f1656d5a8..2461684c430f 100644 --- a/sdk/storage/storage-queue/CHANGELOG.md +++ b/sdk/storage/storage-queue/CHANGELOG.md @@ -167,7 +167,7 @@ - Please refer to the `proxyAuth.ts` sample in the `samples/typescript` folder. - Request and response headers are now logged at INFO level, with sensitive data redacted. -For release notes and more information please visit https://aka.ms/azsdk/releases/July2019Preview +For release notes and more information please visit https://aka.ms/azsdk/releases/july2019preview ## 10.3.0 (2019.09)