diff --git a/common/tools/dev-tool/src/templates/sampleReadme.md.ts b/common/tools/dev-tool/src/templates/sampleReadme.md.ts index e8134874edd4..3d5179c38284 100644 --- a/common/tools/dev-tool/src/templates/sampleReadme.md.ts +++ b/common/tools/dev-tool/src/templates/sampleReadme.md.ts @@ -6,7 +6,6 @@ import YAML from "yaml"; import prettier from "prettier"; -import { MIN_SUPPORTED_NODE_VERSION } from "../util/sampleConfiguration"; import { SampleReadmeConfiguration } from "../util/sampleGenerationInfo"; /** @@ -166,7 +165,7 @@ ${table(info)} ## Prerequisites -The sample programs are compatible with Node.js >=${MIN_SUPPORTED_NODE_VERSION}. +The sample programs are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). ${(() => { if (info.useTypeScript) { diff --git a/samples/cors/ts/README.md b/samples/cors/ts/README.md index 6b00b2e2e812..901bd7c038f6 100644 --- a/samples/cors/ts/README.md +++ b/samples/cors/ts/README.md @@ -37,7 +37,7 @@ This sample demonstrates a few alternatives to integrating with Azure Key Vault ## Prerequisites -The sample is compatible with Node.js >= 8.0.0 +The sample is compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/) Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. diff --git a/samples/frameworks/electron/ts/README.md b/samples/frameworks/electron/ts/README.md index f5eaded2b3ff..66ec3b7c8d9e 100644 --- a/samples/frameworks/electron/ts/README.md +++ b/samples/frameworks/electron/ts/README.md @@ -9,7 +9,7 @@ In this sample, we build a simple [Electron][electron] application and integrati ## Prerequisites -The samples are compatible with Node.js >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/) Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. diff --git a/samples/frameworks/react/ts/README.md b/samples/frameworks/react/ts/README.md index 6bcb75274acc..6669d7a4cd5d 100644 --- a/samples/frameworks/react/ts/README.md +++ b/samples/frameworks/react/ts/README.md @@ -9,7 +9,7 @@ In this sample, we build a simple Todo application in React using [create-react- ## Prerequisites -The samples are compatible with Node.js >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. diff --git a/samples/web-workers/README.md b/samples/web-workers/README.md index 6ee676a2d543..ebe9d895f511 100644 --- a/samples/web-workers/README.md +++ b/samples/web-workers/README.md @@ -12,7 +12,7 @@ In this sample we demonstrate how to polyfill the necessary APIs for using our l ### XML Parsing -When used in the browser, our XML parsing library relies on DOM APIs to support parsing and stringifying XML. Since the DOM APIs are generally available this reduces bundle size and minimizes our dependencies. When running from a Web Worker, however, DOM APIs are not available. This is a browser limitation and requires a polyfill before importing our client libraries in web workers. +When used in the browser, our XML parsing library relies on DOM APIs to support parsing and stringifying XML. Since the DOM APIs are generally available this reduces bundle size and minimizes our dependencies. When running from a Web Worker, however, DOM APIs are not available. This is a browser limitation and requires a polyfill before importing our client libraries in web workers. > Note: Not all client libraries use XML. When running in a web worker, our library will emit a useful error explaining what APIs are required if they are missing so that you can add them as needed. @@ -20,7 +20,7 @@ In these samples we use [JSDOM][jsdom] but you can use any library that provides ## Prerequisites -The samples are compatible with Node.js >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the TypeScript samples, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. diff --git a/sdk/anomalydetector/ai-anomaly-detector/README.md b/sdk/anomalydetector/ai-anomaly-detector/README.md index 5a3e1e4969d9..2c0e3f8dac40 100644 --- a/sdk/anomalydetector/ai-anomaly-detector/README.md +++ b/sdk/anomalydetector/ai-anomaly-detector/README.md @@ -6,8 +6,8 @@ Key links: - [Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/) - [Package (NPM)](https://www.npmjs.com/package/@azure/ai-anomaly-detector) -- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/ai-anomaly-detector) -- [Product documentation](https://docs.microsoft.com/azure/cognitive-services/anomaly-detector/) +- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/ai-anomaly-detector) +- [Product documentation](https://docs.microsoft.com/azure/cognitive-services/anomaly-detector/) - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/anomalydetector/ai-anomaly-detector/samples) ## Key concepts @@ -22,7 +22,10 @@ The `AnomalyDetectorClient` provides methods for anomaly detection: ### Currently supported environments -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites diff --git a/sdk/appconfiguration/app-configuration/README.md b/sdk/appconfiguration/app-configuration/README.md index d4ce5d88fb10..6ff3e01d9005 100644 --- a/sdk/appconfiguration/app-configuration/README.md +++ b/sdk/appconfiguration/app-configuration/README.md @@ -24,10 +24,17 @@ Key links: npm install @azure/app-configuration ``` +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + ### Prerequisites -- You must have an [Azure Subscription](https://azure.microsoft.com) and an [App Configuration](https://docs.microsoft.com/azure/azure-app-configuration/) resource to use this package. -- Node.js version 8.x.x or higher +- An [Azure Subscription](https://azure.microsoft.com) +- An [App Configuration](https://docs.microsoft.com/azure/azure-app-configuration/) resource ### Create an App Configuration resource diff --git a/sdk/appconfiguration/app-configuration/sample-react/README.md b/sdk/appconfiguration/app-configuration/sample-react/README.md index b74c4757d55c..edf3a602c234 100644 --- a/sdk/appconfiguration/app-configuration/sample-react/README.md +++ b/sdk/appconfiguration/app-configuration/sample-react/README.md @@ -4,7 +4,7 @@ This sample application shows how to use the Feature Flags. ## Prerequisites -The samples are compatible with Node.js >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and the following resources created to run this sample: diff --git a/sdk/attestation/attestation/README.md b/sdk/attestation/attestation/README.md index c286f33ef2a6..afec50a24ce6 100644 --- a/sdk/attestation/attestation/README.md +++ b/sdk/attestation/attestation/README.md @@ -14,25 +14,28 @@ For a more complete view of Azure libraries, see the [azure sdk typescript relea Key links: -- [Source code][source_code] -- [Package (NPM)][Attestation_npm] -- [API reference documentation][API_reference] +- [Source code][source_code] +- [Package (NPM)][attestation_npm] +- [API reference documentation][api_reference] - [Product documentation](https://docs.microsoft.com/azure/attestation/) ## Getting started ### Currently supported environments -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites -- An Azure subscription. To use Azure services, including the Microsoft Azure Attestation service, you'll need a subscription. If you do not have an existing Azure account, you may sign up for a [free trial][azure_sub] or use your [Visual Studio Subscription](https://visualstudio.microsoft.com/subscriptions/) benefits when you [create an account](https://account.windowsazure.com/Home/Index). +- An [Azure Subscription](https://azure.microsoft.com) - An existing Azure Attestation Instance, or you can use the "shared provider" available in each Azure region. If you need to create an Azure Attestation service instance, you can use the Azure Portal or [Azure CLI][azure_cli]. ### Install the @azure/attestation package -Install the Microsoft Azure Attestation client library for JavaScript with [NPM][Attestation_npm]: +Install the Microsoft Azure Attestation client library for JavaScript with [NPM][attestation_npm]: ```Powershell npm install @azure/attestation @@ -41,9 +44,9 @@ npm install @azure/attestation ### Authenticate the client In order to interact with the Microsoft Azure Attestation service, you'll need to create an instance of the [Attestation Client][attestation_client] or [Attestation Administration Client][attestation_admin_client] class. You need a **attestation instance url**, which you may see as "DNS Name" in the portal, - and **client secret credentials (client id, client secret, tenant id)** to instantiate a client object. +and **client secret credentials (client id, client secret, tenant id)** to instantiate a client object. -Client secret credential authentication is being used in this getting started section but you can find more ways to authenticate with [Azure identity][azure_identity]. To use the [DefaultAzureCredential][DefaultAzureCredential] provider shown below, +Client secret credential authentication is being used in this getting started section but you can find more ways to authenticate with [Azure identity][azure_identity]. To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, you should install the Azure.Identity package: ```Powershell @@ -56,35 +59,35 @@ Use the [Azure CLI][azure_cli] snippet below to create/get client secret credent - Create a service principal and configure its access to Azure resources: - ```Powershell - az ad sp create-for-rbac -n --skip-assignment - ``` + ```Powershell + az ad sp create-for-rbac -n --skip-assignment + ``` - Output: + Output: - ```json - { - "appId": "generated-app-ID", - "displayName": "dummy-app-name", - "name": "http://dummy-app-name", - "password": "random-password", - "tenant": "tenant-ID" - } - ``` + ```json + { + "appId": "generated-app-ID", + "displayName": "dummy-app-name", + "name": "http://dummy-app-name", + "password": "random-password", + "tenant": "tenant-ID" + } + ``` - Take note of the service principal objectId - ```Powershell - az ad sp show --id --query objectId - ``` + ```Powershell + az ad sp show --id --query objectId + ``` - Output: + Output: - ```Powershell - "" - ``` + ```Powershell + "" + ``` -- Use the returned credentials above to set **AZURE_CLIENT_ID** (appId), **AZURE_CLIENT_SECRET** (password), and **AZURE_TENANT_ID** (tenant) environment variables. The following example shows a way to do this in Powershell: +- Use the returned credentials above to set **AZURE_CLIENT_ID** (appId), **AZURE_CLIENT_SECRET** (password), and **AZURE_TENANT_ID** (tenant) environment variables. The following example shows a way to do this in Powershell: ```Powershell $Env:AZURE_CLIENT_ID="generated-app-ID" @@ -99,7 +102,7 @@ For more information about the Azure Identity APIs and how to use them, see [Azu There are four major families of functionality provided in this preview SDK: - [SGX and TPM enclave attestation.](#attestation) -- [MAA Attestation Token signing certificate discovery and validation.](#attestation-token-signing-certificate-discovery-and-validation) +- [MAA Attestation Token signing certificate discovery and validation.](#attestation-token-signing-certificate-discovery-and-validation) - [Attestation Policy management.](#policy-management) - [Attestation policy management certificate management](#policy-management-certificate-management) (yes, policy management management). @@ -143,9 +146,9 @@ clients to "roll" the policy management certificates. ### Isolated Mode and AAD Mode -Each Microsoft Azure Attestation service instance operates in either "AAD" mode or "Isolated" mode. When an MAA instance is operating in AAD mode, it means that the customer which created the attestation instance allows Azure Active Directory and Azure Role Based Access control policies to verify access to the attestation instance. +Each Microsoft Azure Attestation service instance operates in either "AAD" mode or "Isolated" mode. When an MAA instance is operating in AAD mode, it means that the customer which created the attestation instance allows Azure Active Directory and Azure Role Based Access control policies to verify access to the attestation instance. -### *AttestationType* +### _AttestationType_ The Microsoft Azure Attestation service supports attesting different types of evidence depending on the environment. Currently, MAA supports the following Trusted Execution environments: @@ -186,13 +189,13 @@ The `getPolicy` method retrieves the attestation policy from the service. Attestation Policies are instanced on a per-attestation type basis, the `AttestationType` parameter defines the type to retrieve. ```js - const policyResult = await adminClient.getPolicy(attestationType); +const policyResult = await adminClient.getPolicy(attestationType); - // The text policy document is available in the `policyResult.value` - // property. +// The text policy document is available in the `policyResult.value` +// property. - // The actual attestation token returned by the MAA service is available - // in `policyResult.token`. +// The actual attestation token returned by the MAA service is available +// in `policyResult.token`. ``` ### Set an attestation policy for a specified attestation type @@ -222,20 +225,19 @@ There are two properties provided in the [PolicyResult][attestation_policy_resul To verify the hash, clients can generate an attestation token and verify the hash generated from that token: ```js - const expectedPolicy = AttestationToken.create( - { - body: new StoredAttestationPolicy(minimalPolicy).serialize(), - signer: signer - }); - - // Use your favorite SHA256 hash generator function to create a hash of the - // stringized JWS. The tests in this package use `KJUR.crypto.Util.hashString(buffer, "sha256")` - // from the `jsrsasign` library, but any crypto library will - // work. - const expectedHash = generateSha256Hash(expectedPolicy.serialize()); - - // The hash returned in expectedHash will match the value in - // `setResult.value.policy_token_hash. +const expectedPolicy = AttestationToken.create({ + body: new StoredAttestationPolicy(minimalPolicy).serialize(), + signer: signer +}); + +// Use your favorite SHA256 hash generator function to create a hash of the +// stringized JWS. The tests in this package use `KJUR.crypto.Util.hashString(buffer, "sha256")` +// from the `jsrsasign` library, but any crypto library will +// work. +const expectedHash = generateSha256Hash(expectedPolicy.serialize()); + +// The hash returned in expectedHash will match the value in +// `setResult.value.policy_token_hash. ``` ### Attest SGX Enclave @@ -248,7 +250,7 @@ One solution to this problem is what is known as "Secure Key Release", which is To implement the "Secure Key Release" pattern, the enclave code generates an ephemeral asymmetric key. It then serializes the public portion of the key to some format (possibly a JSON Web Key, or PEM, or some other serialization format). -The enclave code then calculates the SHA256 value of the public key and passes it as an input to code which generates an SGX Quote (for OpenEnclave, that would be the [oe_get_evidence](https://openenclave.io/apidocs/v0.14/attester_8h_a7d197e42468636e95a6ab97b8e74c451.html#a7d197e42468636e95a6ab97b8e74c451) or [oe_get_report](https://openenclave.io/apidocs/v0.14/enclave_8h_aefcb89c91a9078d595e255bd7901ac71.html#aefcb89c91a9078d595e255bd7901ac71)). +The enclave code then calculates the SHA256 value of the public key and passes it as an input to code which generates an SGX Quote (for OpenEnclave, that would be the [oe_get_evidence](https://openenclave.io/apidocs/v0.14/attester_8h_a7d197e42468636e95a6ab97b8e74c451.html#a7d197e42468636e95a6ab97b8e74c451) or [oe_get_report](https://openenclave.io/apidocs/v0.14/enclave_8h_aefcb89c91a9078d595e255bd7901ac71.html#aefcb89c91a9078d595e255bd7901ac71)). The client then sends the SGX quote and the serialized key to the attestation service. The attestation service will validate the quote and ensure that the hash of the key is present in the quote and will issue an "Attestation Token". @@ -259,11 +261,9 @@ This example shows one common pattern of calling into the attestation service to This example assumes that you have an existing `AttestationClient` object which is configured with the base URI for your endpoint. It also assumes that you have an SGX Quote (`quote`) generated from within the SGX enclave you are attesting, and "Runtime Data" (`binaryRuntimeData`) which is referenced in the SGX Quote. ```ts - const attestationResult = await client.attestOpenEnclave( - quote, - { - runTimeData: new AttestationData(binaryRuntimeData, false), - }); +const attestationResult = await client.attestOpenEnclave(quote, { + runTimeData: new AttestationData(binaryRuntimeData, false) +}); ``` If the `isJson` parameter to the `AttestationData` constructor is not provided, @@ -323,17 +323,18 @@ If you encounter any bugs or have suggestions, please file an issue in the section of the project. + [source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/attestation/attestation [azure_identity]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/2.0.0-beta.3/index.html -[DefaultAzureCredential]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/2.0.0-beta.3/classes/defaultazurecredential.html -[attestation_policy_result]:https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/interfaces/policyresult.html +[defaultazurecredential]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/2.0.0-beta.3/classes/defaultazurecredential.html +[attestation_policy_result]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/interfaces/policyresult.html [attestation_client]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/classes/attestationclient.html [attestation_admin_client]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/classes/attestationclient.html [attestation_response]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/interfaces/attestationresponse.html [attestation_policy_result_parameters]: https://www.microsoft.com/ [attest_sgx]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/classes/attestation.html#attestsgxenclave [attestation_npm]: https://www.npmjs.com/package/@azure/attestation -[API_reference]:https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/index.html +[api_reference]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/index.html [style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization [style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide [microsoft_code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ @@ -341,7 +342,7 @@ section of the project. [azure_sub]: https://azure.microsoft.com/free/ [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ [json_web_token]: https://tools.ietf.org/html/rfc7519 -[JWK]: https://tools.ietf.org/html/rfc7517 +[jwk]: https://tools.ietf.org/html/rfc7517 [base64url_encoding]: https://tools.ietf.org/html/rfc4648#section-5 [contributing]: https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ diff --git a/sdk/containerregistry/container-registry/README.md b/sdk/containerregistry/container-registry/README.md index e50c8193411e..8a2ee1b1eb71 100644 --- a/sdk/containerregistry/container-registry/README.md +++ b/sdk/containerregistry/container-registry/README.md @@ -20,11 +20,15 @@ Use the client library for Azure Container Registry to: ### Currently supported environments -- Node.js version 8.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites -You need an [Azure subscription][azure_sub] and a [Container Registry account][container_registry_docs] to use this package. +- An [Azure Subscription](https://azure.microsoft.com) +- A [Container Registry account][container_registry_docs] To create a new Container Registry, you can use the [Azure Portal][container_registry_create_portal], [Azure PowerShell][container_registry_create_ps], or the [Azure CLI][container_registry_create_cli]. diff --git a/sdk/core/core-amqp/README.md b/sdk/core/core-amqp/README.md index 501af61fb46d..fb04fb486d65 100644 --- a/sdk/core/core-amqp/README.md +++ b/sdk/core/core-amqp/README.md @@ -14,9 +14,12 @@ Install this library using npm as follows: npm install @azure/core-amqp ``` -### Prerequisites +### Currently supported environments -If you are using this package in a Node.js application, then use Node.js 8.x or higher. +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ## Key concepts diff --git a/sdk/core/core-client-rest/README.md b/sdk/core/core-client-rest/README.md index 4cdcdbe50460..4a095693277f 100644 --- a/sdk/core/core-client-rest/README.md +++ b/sdk/core/core-client-rest/README.md @@ -6,7 +6,12 @@ This library is primarily intended to be used in code generated by [AutoRest](ht ### Requirements -- [Node.js](https://nodejs.org) version > 8.x +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Installation diff --git a/sdk/core/core-client/README.md b/sdk/core/core-client/README.md index 04d1b88b1d4b..3cae0857ee55 100644 --- a/sdk/core/core-client/README.md +++ b/sdk/core/core-client/README.md @@ -4,9 +4,12 @@ This library is primarily intended to be used in code generated by [AutoRest](ht ## Getting started -### Requirements +### Currently supported environments -- [Node.js](https://nodejs.org) version > 8.x +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Installation diff --git a/sdk/core/core-crypto/README.md b/sdk/core/core-crypto/README.md index 0e5e0738f7f4..f609cf210dfc 100644 --- a/sdk/core/core-crypto/README.md +++ b/sdk/core/core-crypto/README.md @@ -6,7 +6,12 @@ This library is primarily intended to contain cryptographic helper functions for ### Requirements -- [Node.js](https://nodejs.org) version > 8.x +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Installation diff --git a/sdk/core/core-http/README.md b/sdk/core/core-http/README.md index 860078fff69e..2ee90212ff09 100644 --- a/sdk/core/core-http/README.md +++ b/sdk/core/core-http/README.md @@ -4,14 +4,12 @@ This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in ## Getting started -### Requirements +### Currently supported environments -- [Node.js](https://nodejs.org) version > 8.x -- Typescript compiler +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. -```shell -npm install -g typescript -``` +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Installation diff --git a/sdk/core/core-rest-pipeline/README.md b/sdk/core/core-rest-pipeline/README.md index 4412f183a9bb..28e1808b5cf3 100644 --- a/sdk/core/core-rest-pipeline/README.md +++ b/sdk/core/core-rest-pipeline/README.md @@ -6,7 +6,12 @@ This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in ### Requirements -- [Node.js](https://nodejs.org) version > 8.x +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Installation diff --git a/sdk/core/core-util/README.md b/sdk/core/core-util/README.md index 299357f28332..a975072b968f 100644 --- a/sdk/core/core-util/README.md +++ b/sdk/core/core-util/README.md @@ -6,7 +6,12 @@ This library is intended to provide various shared utility functions for client ### Requirements -- [Node.js](https://nodejs.org) version > 8.x +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Installation diff --git a/sdk/core/core-xml/README.md b/sdk/core/core-xml/README.md index 63acacf44ad1..902a7dafc21e 100644 --- a/sdk/core/core-xml/README.md +++ b/sdk/core/core-xml/README.md @@ -6,7 +6,12 @@ This library is primarily intended to be used in code generated by [AutoRest](ht ### Requirements -- [Node.js](https://nodejs.org) version > 8.x +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Installation diff --git a/sdk/cosmosdb/cosmos/README.md b/sdk/cosmosdb/cosmos/README.md index 9d6d0f456e1b..5006c6544919 100644 --- a/sdk/cosmosdb/cosmos/README.md +++ b/sdk/cosmosdb/cosmos/README.md @@ -203,7 +203,7 @@ try { ### Transpiling -The Azure SDKs are designed to support ES5 JavaScript syntax and a minimum version of Node 8. If you need support for earlier JavaScript runtimes such as Internet Explorer or Node 6, you will need to transpile the SDK code as part of your build process. +The Azure SDKs are designed to support ES5 JavaScript syntax and [LTS versions of Node.js](https://nodejs.org/about/releases/). If you need support for earlier JavaScript runtimes such as Internet Explorer or Node 6, you will need to transpile the SDK code as part of your build process. ### Handle transient errors with retries diff --git a/sdk/deviceupdate/iot-device-update/README.md b/sdk/deviceupdate/iot-device-update/README.md index f9413b812fa4..f97bd2266f1c 100644 --- a/sdk/deviceupdate/iot-device-update/README.md +++ b/sdk/deviceupdate/iot-device-update/README.md @@ -8,7 +8,7 @@ The library provides access to the Device Update for IoT Hub service that enable ### Currently supported environments -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) ### Prerequisites diff --git a/sdk/digitaltwins/digital-twins-core/README.md b/sdk/digitaltwins/digital-twins-core/README.md index 5f5b5245d50b..2856d11c03d4 100644 --- a/sdk/digitaltwins/digital-twins-core/README.md +++ b/sdk/digitaltwins/digital-twins-core/README.md @@ -6,8 +6,10 @@ This package contains an isomorphic SDK for Azure Digital Twins API to provide a ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites diff --git a/sdk/eventgrid/eventgrid/README.md b/sdk/eventgrid/eventgrid/README.md index 5e5681e18e48..6f1e21cb518a 100644 --- a/sdk/eventgrid/eventgrid/README.md +++ b/sdk/eventgrid/eventgrid/README.md @@ -18,12 +18,12 @@ Use the client library to: ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript - - Apple Safari: latest two versions - - Google Chrome: latest two versions - - Microsoft Edge: all supported versions - - Mozilla FireFox: latest two versions +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites diff --git a/sdk/eventhub/event-hubs/README.md b/sdk/eventhub/event-hubs/README.md index 5656075c7919..70db54a67360 100644 --- a/sdk/eventhub/event-hubs/README.md +++ b/sdk/eventhub/event-hubs/README.md @@ -27,11 +27,17 @@ Install the Azure Event Hubs client library using npm `npm install @azure/event-hubs` +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + ### Prerequisites -You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/) to use this package. -If you are using this package in a Node.js application, then use Node.js 8.x or higher. +- An [Azure subscription](https://azure.microsoft.com/free/) +- An [Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/) #### Configure Typescript diff --git a/sdk/eventhub/event-hubs/samples-browser/README.md b/sdk/eventhub/event-hubs/samples-browser/README.md index e37554524b8e..63cca58db52c 100644 --- a/sdk/eventhub/event-hubs/samples-browser/README.md +++ b/sdk/eventhub/event-hubs/samples-browser/README.md @@ -22,7 +22,7 @@ This sample programs show how to use the JavaScript client libraries for Azure E ## Prerequisites -The samples are compatible with Node.js >= 8.0.0 and run in browsers that support async/await (e.g. Edge, Firefox, Chrome.) +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/) and run in browsers that support async/await (e.g. Edge, Firefox, Chrome.) You need [an Azure subscription][freesub] and [an Azure Event Hub resource][azhubacct] to run these sample programs. Samples retrieve credentials using the [InteractiveBrowserCredential][browsercred] from `@azure/identity`. diff --git a/sdk/eventhub/event-hubs/samples-express/README.md b/sdk/eventhub/event-hubs/samples-express/README.md index be5e68b8ec86..cafe39c216f7 100644 --- a/sdk/eventhub/event-hubs/samples-express/README.md +++ b/sdk/eventhub/event-hubs/samples-express/README.md @@ -10,7 +10,7 @@ One scenario is building an HTTP-based service that accepts events as part of an ## Prerequisites -The samples are compatible with Node.js >= 8.0.0 and run in express. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/) and run in express. You need [an Azure subscription][freesub] and [an Azure Event Hub resource][azhubacct] to run these sample programs. diff --git a/sdk/eventhub/event-hubs/samples/v5/browser/README.md b/sdk/eventhub/event-hubs/samples/v5/browser/README.md index e37554524b8e..63cca58db52c 100644 --- a/sdk/eventhub/event-hubs/samples/v5/browser/README.md +++ b/sdk/eventhub/event-hubs/samples/v5/browser/README.md @@ -22,7 +22,7 @@ This sample programs show how to use the JavaScript client libraries for Azure E ## Prerequisites -The samples are compatible with Node.js >= 8.0.0 and run in browsers that support async/await (e.g. Edge, Firefox, Chrome.) +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/) and run in browsers that support async/await (e.g. Edge, Firefox, Chrome.) You need [an Azure subscription][freesub] and [an Azure Event Hub resource][azhubacct] to run these sample programs. Samples retrieve credentials using the [InteractiveBrowserCredential][browsercred] from `@azure/identity`. diff --git a/sdk/eventhub/event-hubs/samples/v5/express/README.md b/sdk/eventhub/event-hubs/samples/v5/express/README.md index be5e68b8ec86..cafe39c216f7 100644 --- a/sdk/eventhub/event-hubs/samples/v5/express/README.md +++ b/sdk/eventhub/event-hubs/samples/v5/express/README.md @@ -10,7 +10,7 @@ One scenario is building an HTTP-based service that accepts events as part of an ## Prerequisites -The samples are compatible with Node.js >= 8.0.0 and run in express. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/) and run in express. You need [an Azure subscription][freesub] and [an Azure Event Hub resource][azhubacct] to run these sample programs. diff --git a/sdk/eventhub/event-hubs/samples/v5/javascript/README.md b/sdk/eventhub/event-hubs/samples/v5/javascript/README.md index e231efd49ea2..3a168874e742 100644 --- a/sdk/eventhub/event-hubs/samples/v5/javascript/README.md +++ b/sdk/eventhub/event-hubs/samples/v5/javascript/README.md @@ -23,7 +23,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The sample programs are compatible with Node.js >=12.0.0. +The sample programs are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and the following Azure resources to run these sample programs: diff --git a/sdk/eventhub/event-hubs/samples/v5/typescript/README.md b/sdk/eventhub/event-hubs/samples/v5/typescript/README.md index 5ef84e59494a..37d3c5a10373 100644 --- a/sdk/eventhub/event-hubs/samples/v5/typescript/README.md +++ b/sdk/eventhub/event-hubs/samples/v5/typescript/README.md @@ -23,7 +23,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The sample programs are compatible with Node.js >=12.0.0. +The sample programs are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using: diff --git a/sdk/eventhub/eventhubs-checkpointstore-blob/README.md b/sdk/eventhub/eventhubs-checkpointstore-blob/README.md index 0fe085452376..9d797d546e05 100644 --- a/sdk/eventhub/eventhubs-checkpointstore-blob/README.md +++ b/sdk/eventhub/eventhubs-checkpointstore-blob/README.md @@ -6,17 +6,25 @@ An Azure Blob storage based solution to store checkpoints and to aid in load bal ## Getting started +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + +### Prerequisites + +- An [Azure subscription](https://azure.microsoft.com/free/) +- An [Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/) +- A [Storage account](https://docs.microsoft.com/azure/storage/blobs/storage-blobs-introduction) + ### Install the package Install the Azure Event Hubs Checkpoint Store Blob library using npm `npm install @azure/eventhubs-checkpointstore-blob` -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/), an -[Event Hubs Namespace](https://docs.microsoft.com/azure/event-hubs/) to use this package, and a [Storage account](https://docs.microsoft.com/azure/storage/blobs/storage-blobs-introduction) - -If you are using this package in a Node.js application, then use Node.js 8.x or higher. - ### Configure Typescript TypeScript users need to have Node type definitions installed: diff --git a/sdk/formrecognizer/ai-form-recognizer/README.md b/sdk/formrecognizer/ai-form-recognizer/README.md index 3559603dfaa7..abad31debe7a 100644 --- a/sdk/formrecognizer/ai-form-recognizer/README.md +++ b/sdk/formrecognizer/ai-form-recognizer/README.md @@ -16,10 +16,16 @@ Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/ ## Getting started +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + ### Prerequisites -- [Node.js](https://nodejs.org/) version 8.x.x or higher -- An [Azure subscription][azure_sub]. +- An [Azure subscription](https://azure.microsoft.com/free/) - A [Cognitive Services or Form Recognizer resource][fr_or_cs_resource]. If you need to create the resource, you can use the [Azure Portal][azure_portal] or [Azure CLI][azure_cli]. #### Create a Form Recognizer resource diff --git a/sdk/identity/identity/samples/javascript/README.md b/sdk/identity/identity/samples/javascript/README.md index 372288c6fdd5..65f379a3794e 100644 --- a/sdk/identity/identity/samples/javascript/README.md +++ b/sdk/identity/identity/samples/javascript/README.md @@ -20,7 +20,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Key Vault][azkeyvault] to run these sample programs. diff --git a/sdk/identity/identity/samples/typescript/README.md b/sdk/identity/identity/samples/typescript/README.md index bb33229b0c14..537aeaae9ec7 100644 --- a/sdk/identity/identity/samples/typescript/README.md +++ b/sdk/identity/identity/samples/typescript/README.md @@ -20,7 +20,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.ts >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to TypeScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/identity/perf-tests/identity/README.md b/sdk/identity/perf-tests/identity/README.md index b88cbee15974..ac4ebfc1594e 100644 --- a/sdk/identity/perf-tests/identity/README.md +++ b/sdk/identity/perf-tests/identity/README.md @@ -1,8 +1,5 @@ ### Guide -**Important:** -These tests won't work on Node 8 nor Node 15. - 1. Build the Identity perf tests package `rush build -t perf-identity`. 2. Copy the `sample.env` file and name it as `.env`. 3. Populate the `.env` file with your Azure Credentials. diff --git a/sdk/iot/iot-modelsrepository/README.md b/sdk/iot/iot-modelsrepository/README.md index 6929ea69e592..0753a1165e7d 100644 --- a/sdk/iot/iot-modelsrepository/README.md +++ b/sdk/iot/iot-modelsrepository/README.md @@ -16,8 +16,10 @@ The Azure IoT Models Repository library for JavaScript provides functionality fo ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### How to Install diff --git a/sdk/keyvault/keyvault-secrets/README.md b/sdk/keyvault/keyvault-secrets/README.md index 2d2f356e3d82..cc12e3849811 100644 --- a/sdk/keyvault/keyvault-secrets/README.md +++ b/sdk/keyvault/keyvault-secrets/README.md @@ -23,10 +23,14 @@ Use the client library for Azure Key Vault Secrets in your Node.js application t ## Getting started -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal) to use this package. +### Currently supported environments -If you are using this package in a Node.js application, then use Node.js 8.x or higher. +- [LTS versions of Node.js](https://nodejs.org/about/releases/) + +### Prerequisites + +- An [Azure subscription](https://azure.microsoft.com/free/) +- A[Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal) ### Install the package diff --git a/sdk/metricsadvisor/ai-metrics-advisor/README.md b/sdk/metricsadvisor/ai-metrics-advisor/README.md index 48c691adcbcb..c2d19107320a 100644 --- a/sdk/metricsadvisor/ai-metrics-advisor/README.md +++ b/sdk/metricsadvisor/ai-metrics-advisor/README.md @@ -17,7 +17,10 @@ Metrics Advisor is a part of Azure Cognitive Services that uses AI perform data ### Currently supported environments -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites diff --git a/sdk/mixedreality/mixedreality-authentication/README.md b/sdk/mixedreality/mixedreality-authentication/README.md index efc2668f3a60..288023bba79c 100644 --- a/sdk/mixedreality/mixedreality-authentication/README.md +++ b/sdk/mixedreality/mixedreality-authentication/README.md @@ -15,7 +15,7 @@ token from the STS that can be used to access Mixed Reality services. ### Currently supported environments -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) ### Prerequisites diff --git a/sdk/monitor/monitor-opentelemetry-exporter/README.md b/sdk/monitor/monitor-opentelemetry-exporter/README.md index e030b57c45dc..ba19340f85a9 100644 --- a/sdk/monitor/monitor-opentelemetry-exporter/README.md +++ b/sdk/monitor/monitor-opentelemetry-exporter/README.md @@ -10,11 +10,17 @@ This exporter package assumes your application is [already instrumented](https:/ `npm install @azure/monitor-opentelemetry-exporter` +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + ### Prerequisites -You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Application Insights workspace](https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview/) to use this package. -If you are using this package in a Node.js application, then use Node.js 8.5.0 or higher. +- An [Azure subscription](https://azure.microsoft.com/free/) +- An [Application Insights workspace](https://docs.microsoft.com/azure/azure-monitor/app/app-insights-overview/) ### Distributed Tracing diff --git a/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/javascript/README.md b/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/javascript/README.md index f592db7aa39c..2b06bd02e38f 100644 --- a/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/javascript/README.md +++ b/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/javascript/README.md @@ -8,7 +8,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The sample are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. diff --git a/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/typescript/README.md b/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/typescript/README.md index dfe091aa40df..9d8b602ead41 100644 --- a/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/typescript/README.md +++ b/sdk/monitor/monitor-opentelemetry-exporter/samples/@azure/storage-blob/typescript/README.md @@ -8,7 +8,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require a Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/monitor/monitor-query/README.md b/sdk/monitor/monitor-query/README.md index 869c8c2bf9ca..9e2b7dda6ff4 100644 --- a/sdk/monitor/monitor-query/README.md +++ b/sdk/monitor/monitor-query/README.md @@ -21,10 +21,17 @@ Use the client library for Azure Monitor to: npm install @azure/monitor-query ``` +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + ### Prerequisites -- You must have an [Azure Subscription](https://azure.microsoft.com) and an [Azure Monitor][azure_monitor_product_documentation] resource to use this package. -- Node.js version 8.x.x or higher +- An [Azure Subscription](https://azure.microsoft.com) +- An [Azure Monitor][azure_monitor_product_documentation] resource ### Create an Azure Monitor resource diff --git a/sdk/quantum/quantum-jobs/README.md b/sdk/quantum/quantum-jobs/README.md index 1af8f14b5586..65fb3c1ff45d 100644 --- a/sdk/quantum/quantum-jobs/README.md +++ b/sdk/quantum/quantum-jobs/README.md @@ -23,7 +23,7 @@ npm install @azure/quantum-jobs ### Prerequisites -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) - [Azure subscription](https://azure.microsoft.com/free/) - [Azure Quantum Workspace][workspaces] diff --git a/sdk/schemaregistry/schema-registry-avro/README.md b/sdk/schemaregistry/schema-registry-avro/README.md index 6c9f1616d841..ed4dbcdb0619 100644 --- a/sdk/schemaregistry/schema-registry-avro/README.md +++ b/sdk/schemaregistry/schema-registry-avro/README.md @@ -12,7 +12,7 @@ Schema Registry schema identifiers and Avro-encoded data. ## Getting started -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) ### Prerequisites diff --git a/sdk/schemaregistry/schema-registry/README.md b/sdk/schemaregistry/schema-registry/README.md index b36e71f28969..1570c35fe2b2 100644 --- a/sdk/schemaregistry/schema-registry/README.md +++ b/sdk/schemaregistry/schema-registry/README.md @@ -12,7 +12,7 @@ schema identifiers rather than full schemas. ## Getting started -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) ### Prerequisites diff --git a/sdk/search/search-documents/README.md b/sdk/search/search-documents/README.md index 6c3cd90e6e66..535bef75c2be 100644 --- a/sdk/search/search-documents/README.md +++ b/sdk/search/search-documents/README.md @@ -34,8 +34,17 @@ Use the @azure/search-documents client library to: npm install @azure/search-documents ``` +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + ### Prerequisites -This package supports [Node.js](https://nodejs.org/) version 8.x.x or higher. You need an [Azure subscription][azure_sub] and a [search service][create_search_service_docs] to use this package. + +- An [Azure subscription](https://azure.microsoft.com/free/) +- A [Search service][create_search_service_docs] To create a new search service, you can use the [Azure portal][create_search_service_docs], [Azure PowerShell][create_search_service_ps], or the [Azure CLI][create_search_service_cli]. Here's an example using the Azure CLI to create a free instance for getting started: diff --git a/sdk/search/search-documents/samples/javascript/README.md b/sdk/search/search-documents/samples/javascript/README.md index 8759e21fb677..d8c9d48dd99e 100644 --- a/sdk/search/search-documents/samples/javascript/README.md +++ b/sdk/search/search-documents/samples/javascript/README.md @@ -52,7 +52,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Cognitive Search service][search_resource] to run these sample programs. Samples retrieve credentials to access the Azure Cognitive Search endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. diff --git a/sdk/search/search-documents/samples/typescript/README.md b/sdk/search/search-documents/samples/typescript/README.md index 29b51f4b19e5..b8a34f4e53ee 100644 --- a/sdk/search/search-documents/samples/typescript/README.md +++ b/sdk/search/search-documents/samples/typescript/README.md @@ -52,7 +52,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/servicebus/service-bus/README.md b/sdk/servicebus/service-bus/README.md index 8f68bf1aae76..94e5bc16c362 100644 --- a/sdk/servicebus/service-bus/README.md +++ b/sdk/servicebus/service-bus/README.md @@ -27,11 +27,14 @@ Install the latest version for the Azure Service Bus client library using npm. `npm install @azure/service-bus` +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) + ### Prerequisites -You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Service Bus Namespace](https://docs.microsoft.com/azure/service-bus-messaging/) to use this package. -If you are using this package in a Node.js application, then use Node.js 8.x or higher. +- An [Azure subscription](https://azure.microsoft.com/free/) +- A [Service Bus Namespace](https://docs.microsoft.com/azure/service-bus-messaging/) ### Configure Typescript diff --git a/sdk/storage/storage-blob-changefeed/README.md b/sdk/storage/storage-blob-changefeed/README.md index 25185386971b..08910937b2a1 100644 --- a/sdk/storage/storage-blob-changefeed/README.md +++ b/sdk/storage/storage-blob-changefeed/README.md @@ -19,7 +19,17 @@ Use the client libraries in this package to: ## Getting started -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a [Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal) to use this package. If you are using this package in a Node.js application, then Node.js version 8.0.0 or higher is required. +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + +### Prerequisites + +- An [Azure subscription](https://azure.microsoft.com/free/) +- A [Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal) ### Install the package diff --git a/sdk/storage/storage-blob-changefeed/samples/javascript/README.md b/sdk/storage/storage-blob-changefeed/samples/javascript/README.md index 53e08c852bd9..6b91406f94ec 100644 --- a/sdk/storage/storage-blob-changefeed/samples/javascript/README.md +++ b/sdk/storage/storage-blob-changefeed/samples/javascript/README.md @@ -19,7 +19,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The sample are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. diff --git a/sdk/storage/storage-blob-changefeed/samples/typescript/README.md b/sdk/storage/storage-blob-changefeed/samples/typescript/README.md index 38d4e7e10b88..f9abbc33fc69 100644 --- a/sdk/storage/storage-blob-changefeed/samples/typescript/README.md +++ b/sdk/storage/storage-blob-changefeed/samples/typescript/README.md @@ -19,7 +19,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require a Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/storage/storage-blob/README.md b/sdk/storage/storage-blob/README.md index b6fcf181208e..e239c8f958f0 100644 --- a/sdk/storage/storage-blob/README.md +++ b/sdk/storage/storage-blob/README.md @@ -21,7 +21,17 @@ Use the client libraries in this package to: ## Getting started -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a [Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal) to use this package. If you are using this package in a Node.js application, then Node.js version 8.0.0 or higher is required. +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + +### Prerequisites + +- An [Azure subscription](https://azure.microsoft.com/free/) +- A [Storage Account](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal) ### Install the package diff --git a/sdk/storage/storage-blob/samples/javascript/README.md b/sdk/storage/storage-blob/samples/javascript/README.md index 036cea636bfc..48a41ec17359 100644 --- a/sdk/storage/storage-blob/samples/javascript/README.md +++ b/sdk/storage/storage-blob/samples/javascript/README.md @@ -32,7 +32,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The sample are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. diff --git a/sdk/storage/storage-blob/samples/typescript/README.md b/sdk/storage/storage-blob/samples/typescript/README.md index d7f129ee2f7a..198b8a7d7b81 100644 --- a/sdk/storage/storage-blob/samples/typescript/README.md +++ b/sdk/storage/storage-blob/samples/typescript/README.md @@ -32,7 +32,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require a Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/storage/storage-file-datalake/README.md b/sdk/storage/storage-file-datalake/README.md index b4e23c66022e..971999f593e8 100644 --- a/sdk/storage/storage-file-datalake/README.md +++ b/sdk/storage/storage-file-datalake/README.md @@ -18,7 +18,17 @@ Use the client libraries in this package to: ## Getting started -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a [Storage Account](https://docs.microsoft.com/azure/storage/blobs/data-lake-storage-quickstart-create-account?toc=%2Fazure%2Fstorage%2Fblobs%2Ftoc.json#create-an-account-using-the-azure-portal) to use this package. If you are using this package in a Node.js application, then Node.js version 8.0.0 or higher is required. +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + +### Prerequisites + +- An [Azure subscription](https://azure.microsoft.com/free/) +- A [Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create) ### Install the package diff --git a/sdk/storage/storage-file-datalake/samples/javascript/README.md b/sdk/storage/storage-file-datalake/samples/javascript/README.md index 585eadde4fbd..5f023f1a3e25 100644 --- a/sdk/storage/storage-file-datalake/samples/javascript/README.md +++ b/sdk/storage/storage-file-datalake/samples/javascript/README.md @@ -18,7 +18,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The sample are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. diff --git a/sdk/storage/storage-file-datalake/samples/typescript/README.md b/sdk/storage/storage-file-datalake/samples/typescript/README.md index 8eb1ab20cb09..05892a7c9c6f 100644 --- a/sdk/storage/storage-file-datalake/samples/typescript/README.md +++ b/sdk/storage/storage-file-datalake/samples/typescript/README.md @@ -18,7 +18,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require a Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/storage/storage-file-share/README.md b/sdk/storage/storage-file-share/README.md index ffa8022732f8..8d66bef0291f 100644 --- a/sdk/storage/storage-file-share/README.md +++ b/sdk/storage/storage-file-share/README.md @@ -24,7 +24,17 @@ Use the client libraries in this package to: ## Getting started -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a [Storage Account](https://docs.microsoft.com/azure/storage/files/storage-how-to-use-files-portal) to use this package. If you are using this package in a Node.js application, then Node.js version 8.0.0 or higher is required. +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + +### Prerequisites + +- An [Azure subscription](https://azure.microsoft.com/free/) +- A [Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create) ### Install the package diff --git a/sdk/storage/storage-file-share/samples/javascript/README.md b/sdk/storage/storage-file-share/samples/javascript/README.md index 034ad71b44db..b9cda74db589 100644 --- a/sdk/storage/storage-file-share/samples/javascript/README.md +++ b/sdk/storage/storage-file-share/samples/javascript/README.md @@ -27,7 +27,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The sample are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. diff --git a/sdk/storage/storage-file-share/samples/typescript/README.md b/sdk/storage/storage-file-share/samples/typescript/README.md index 8f7f6cd1a89d..b433b23e41f0 100644 --- a/sdk/storage/storage-file-share/samples/typescript/README.md +++ b/sdk/storage/storage-file-share/samples/typescript/README.md @@ -27,7 +27,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require a Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/storage/storage-queue/README.md b/sdk/storage/storage-queue/README.md index 1894ce456bba..9de24b3bca84 100644 --- a/sdk/storage/storage-queue/README.md +++ b/sdk/storage/storage-queue/README.md @@ -19,7 +19,17 @@ Use the client libraries in this package to: ## Getting started -**Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a [Storage Account](https://docs.microsoft.com/azure/storage/queues/storage-quickstart-queues-portal) to use this package. If you are using this package in a Node.js application, then Node.js version 8.0.0 or higher is required. +### Currently supported environments + +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. + +### Prerequisites + +- An [Azure subscription](https://azure.microsoft.com/free/) +- A [Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create) ### Install the package diff --git a/sdk/storage/storage-queue/samples/javascript/README.md b/sdk/storage/storage-queue/samples/javascript/README.md index 7cd54404315b..dc29ef488406 100644 --- a/sdk/storage/storage-queue/samples/javascript/README.md +++ b/sdk/storage/storage-queue/samples/javascript/README.md @@ -25,7 +25,7 @@ These sample programs show how to use the JavaScript client libraries for Azure ## Prerequisites -The sample are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. diff --git a/sdk/storage/storage-queue/samples/typescript/README.md b/sdk/storage/storage-queue/samples/typescript/README.md index 9fa63fb33b32..19e91cabd683 100644 --- a/sdk/storage/storage-queue/samples/typescript/README.md +++ b/sdk/storage/storage-queue/samples/typescript/README.md @@ -25,7 +25,7 @@ These sample programs show how to use the TypeScript client libraries for Azure ## Prerequisites -The samples are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require a Node.js >= 10.0.0. +The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/). Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using diff --git a/sdk/synapse/synapse-access-control/README.md b/sdk/synapse/synapse-access-control/README.md index 340d4f9ec4e2..41717dbfb9f2 100644 --- a/sdk/synapse/synapse-access-control/README.md +++ b/sdk/synapse/synapse-access-control/README.md @@ -12,8 +12,10 @@ npm install @azure/synapse-access-control ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ## Key concepts diff --git a/sdk/synapse/synapse-artifacts/README.md b/sdk/synapse/synapse-artifacts/README.md index bfd18efa8d1e..34dbd1f493d6 100644 --- a/sdk/synapse/synapse-artifacts/README.md +++ b/sdk/synapse/synapse-artifacts/README.md @@ -12,8 +12,10 @@ npm install @azure/synapse-artifacts ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ## Key concepts diff --git a/sdk/synapse/synapse-managed-private-endpoints/README.md b/sdk/synapse/synapse-managed-private-endpoints/README.md index ed1907e29f01..ab29b21b0de2 100644 --- a/sdk/synapse/synapse-managed-private-endpoints/README.md +++ b/sdk/synapse/synapse-managed-private-endpoints/README.md @@ -12,8 +12,10 @@ npm install @azure/synapse-managed-private-endpoints ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ## Key concepts diff --git a/sdk/synapse/synapse-monitoring/README.md b/sdk/synapse/synapse-monitoring/README.md index 4d4fa2785896..8a1b402b4637 100644 --- a/sdk/synapse/synapse-monitoring/README.md +++ b/sdk/synapse/synapse-monitoring/README.md @@ -12,8 +12,10 @@ npm install @azure/synapse-monitoring ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ## Key concepts diff --git a/sdk/synapse/synapse-spark/README.md b/sdk/synapse/synapse-spark/README.md index 6c3ccf8fafb9..7c8a5f62ed7e 100644 --- a/sdk/synapse/synapse-spark/README.md +++ b/sdk/synapse/synapse-spark/README.md @@ -12,8 +12,10 @@ npm install @azure/synapse-spark ### Currently supported environments -- Node.js version 8.x.x or higher -- Browser JavaScript +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ## Key concepts diff --git a/sdk/template/template/README.md b/sdk/template/template/README.md index 1eac9887bbf8..751515cdeb5e 100644 --- a/sdk/template/template/README.md +++ b/sdk/template/template/README.md @@ -8,7 +8,10 @@ This project is used as a template package for the Azure SDK for JavaScript. It ### Currently supported environments -- Node.js version 8.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites diff --git a/sdk/textanalytics/ai-text-analytics/README.md b/sdk/textanalytics/ai-text-analytics/README.md index 88ae43f0f630..bf7f9ea7cc66 100644 --- a/sdk/textanalytics/ai-text-analytics/README.md +++ b/sdk/textanalytics/ai-text-analytics/README.md @@ -31,7 +31,10 @@ Use the client library to: ### Currently supported environments -- Node.js version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) +- Latest versions of Safari, Chrome, Edge, and Firefox. + +See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details. ### Prerequisites diff --git a/sdk/web-pubsub/web-pubsub-express/README.md b/sdk/web-pubsub/web-pubsub-express/README.md index cf662b4d67b7..7793acbbd36a 100644 --- a/sdk/web-pubsub/web-pubsub-express/README.md +++ b/sdk/web-pubsub/web-pubsub-express/README.md @@ -20,7 +20,7 @@ Use the express library to: ### Currently supported environments -- [Node.js](https://nodejs.org/) version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) - [Express](https://expressjs.com/) version 4.x.x or higher ### Prerequisites diff --git a/sdk/web-pubsub/web-pubsub/README.md b/sdk/web-pubsub/web-pubsub/README.md index 30b329111d07..4777f9e2ce21 100644 --- a/sdk/web-pubsub/web-pubsub/README.md +++ b/sdk/web-pubsub/web-pubsub/README.md @@ -35,7 +35,7 @@ Use the library to: ### Currently supported environments -- [Node.js](https://nodejs.org/) version 8.x.x or higher +- [LTS versions of Node.js](https://nodejs.org/about/releases/) ### Prerequisites