From add2f4fb1b1bb4011ca771a6487f5837a0c8b815 Mon Sep 17 00:00:00 2001 From: Sima Zhu <48036328+sima-zhu@users.noreply.github.com> Date: Thu, 17 Sep 2020 20:01:20 -0700 Subject: [PATCH] Replaced relative link with absolute links and remove locale (#11317) Replaced relative link with absolute links and remove locale --- README.md | 4 +- SECURITY.md | 6 +-- common/smoke-test/README.md | 4 +- documentation/Bundling.md | 4 +- documentation/using-azure-identity.md | 48 +++++++++---------- eng/pipelines/templates/steps/analyze.yml | 1 + eng/pipelines/templates/steps/build.yml | 7 --- .../app-configuration/README.md | 10 ++-- .../app-configuration/test/README.md | 6 +-- .../README.md | 2 +- .../cognitiveservices-autosuggest/README.md | 2 +- .../README.md | 6 +-- .../README.md | 2 +- .../README.md | 2 +- .../cognitiveservices-customsearch/README.md | 2 +- .../README.md | 2 +- .../README.md | 2 +- .../cognitiveservices-entitysearch/README.md | 2 +- .../cognitiveservices-face/README.md | 2 +- .../README.md | 2 +- .../cognitiveservices-imagesearch/README.md | 2 +- .../cognitiveservices-localsearch/README.md | 2 +- .../README.md | 2 +- .../cognitiveservices-luis-runtime/README.md | 4 +- .../cognitiveservices-newssearch/README.md | 2 +- .../cognitiveservices-personalizer/README.md | 2 +- .../cognitiveservices-spellcheck/README.md | 2 +- .../cognitiveservices-textanalytics/README.md | 2 +- .../README.md | 2 +- .../cognitiveservices-videosearch/README.md | 2 +- .../cognitiveservices-visualsearch/README.md | 2 +- .../cognitiveservices-websearch/README.md | 2 +- sdk/core/core-amqp/CHANGELOG.md | 2 +- sdk/core/core-amqp/README.md | 10 ++-- sdk/core/core-arm/README.md | 2 +- sdk/core/core-lro/README.md | 4 +- sdk/core/core-lro/samples/README.md | 6 +-- sdk/cosmosdb/cosmos/CHANGELOG.md | 4 +- sdk/cosmosdb/cosmos/Contributing.md | 2 +- sdk/cosmosdb/cosmos/README.md | 40 ++++++++-------- sdk/digitaltwins/digital-twins/README.md | 2 +- .../digital-twins/samples/Readme.md | 8 ++-- sdk/eventgrid/eventgrid/README.md | 6 +-- .../eventgrid/samples/javascript/README.md | 2 +- .../eventgrid/samples/typescript/README.md | 2 +- sdk/eventhub/README.md | 4 +- sdk/eventhub/event-hubs/CHANGELOG.md | 2 +- sdk/eventhub/event-hubs/README.md | 18 +++---- sdk/eventhub/event-hubs/migrationguide.md | 4 +- .../samples/browserSample/README.md | 6 +-- .../event-hubs/samples/javascript/README.md | 2 +- .../event-hubs/samples/typescript/README.md | 2 +- sdk/eventhub/event-hubs/test/README.md | 8 ++-- sdk/eventhub/event-processor-host/README.md | 2 +- .../event-processor-host/samples/README.md | 8 ++-- .../event-processor-host/test/README.md | 12 ++--- .../eventhubs-checkpointstore-blob/README.md | 10 ++-- .../test/README.md | 12 ++--- sdk/identity/identity/CHANGELOG.md | 2 +- sdk/identity/identity/README.md | 2 +- .../Kubernetes/INSTRUCTIONS.md | 4 +- sdk/keyvault/README.md | 26 +++++----- sdk/keyvault/keyvault-admin/README.md | 22 ++++----- sdk/keyvault/keyvault-certificates/README.md | 16 +++---- .../samples/javascript/README.md | 2 +- .../samples/typescript/README.md | 2 +- .../keyvault-certificates/test/README.md | 8 ++-- sdk/keyvault/keyvault-keys/README.md | 16 +++---- sdk/keyvault/keyvault-keys/test/README.md | 8 ++-- sdk/keyvault/keyvault-secrets/README.md | 16 +++---- .../samples/javascript/README.md | 2 +- .../samples/typescript/README.md | 2 +- sdk/keyvault/keyvault-secrets/test/README.md | 8 ++-- .../monitor-opentelemetry-exporter/README.md | 2 +- sdk/schemaregistry/README.md | 4 +- .../samples/javascript/README.md | 4 +- .../samples/typescript/README.md | 2 +- .../samples/javascript/README.md | 4 +- .../samples/typescript/README.md | 4 +- sdk/search/search-documents/test/README.md | 2 +- sdk/servicebus/service-bus/README.md | 10 ++-- sdk/servicefabric/servicefabric/README.md | 2 +- sdk/storage/CONTRIBUTING.md | 6 +-- sdk/storage/README.md | 6 +-- .../storage-blob-changefeed/samples/README.md | 2 +- sdk/storage/storage-blob/CHANGELOG.md | 6 +-- sdk/storage/storage-blob/samples/README.md | 2 +- sdk/storage/storage-blob/test/README.md | 2 +- sdk/storage/storage-datalake/README.md | 2 +- .../storage-file-datalake/samples/README.md | 2 +- .../storage-file-datalake/test/README.md | 2 +- sdk/storage/storage-file-share/CHANGELOG.md | 6 +-- sdk/storage/storage-file-share/README.md | 2 +- sdk/storage/storage-file-share/test/README.md | 2 +- sdk/storage/storage-queue/CHANGELOG.md | 4 +- sdk/storage/storage-queue/test/README.md | 2 +- sdk/template/template/README-TEMPLATE.md | 2 +- sdk/template/template/README.md | 2 +- sdk/test-utils/perfstress/README.md | 4 +- 99 files changed, 270 insertions(+), 276 deletions(-) diff --git a/README.md b/README.md index 5fe9bb3d6414..e1f8f7355575 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Packages](https://img.shields.io/badge/packages-latest-blue.svg)](https://azure.github.io/azure-sdk/releases/latest/js.html) [![Dependencies](https://img.shields.io/badge/dependency-report-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-js/dependencies/dependencies.html) [![DependencyGraph](https://img.shields.io/badge/dependency-graph-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-js/dependencies/InterdependencyGraph.html) -This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/en-us/javascript/azure/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-js). +This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/javascript/azure/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-js). ## Getting started @@ -41,7 +41,7 @@ Libraries which enable you to provision specific resources. They are responsible Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) . You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue). ## Contributing -For details on contributing to this repository, see the [contributing guide](CONTRIBUTING.md). +For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md). This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. diff --git a/SECURITY.md b/SECURITY.md index 926b8ae4059a..dec3d3b7013b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,7 +4,7 @@ Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). -If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. ## Reporting Security Issues @@ -12,7 +12,7 @@ If you believe you have found a security vulnerability in any Microsoft-owned re Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). -If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/msrc/pgp-key-msrc). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). @@ -36,6 +36,6 @@ We prefer all communications to be in English. ## Policy -Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/msrc/cvd). diff --git a/common/smoke-test/README.md b/common/smoke-test/README.md index f38e97f4b10d..4d4136d5fe97 100644 --- a/common/smoke-test/README.md +++ b/common/smoke-test/README.md @@ -5,7 +5,7 @@ uses package dependencies, loads all packages into a single process, and executes code samples to ensure basic end to end scenarios work as expected. Smoke Tests are meant to be run periodically in an Azure DevOps pipeline. See -[`smoke-tests.yml`](./smoke-tests.yml) to configure Smoke Tests in an Azure +[`smoke-tests.yml`](https://github.com/Azure/azure-sdk-for-js/blob/master/common/smoke-test/smoke-tests.yml) to configure Smoke Tests in an Azure DevOps pipeline. When run in an Azure DevOps pipeline specify the `-CI` flag to ensure environment variables are properly set and error/warning messages are properly surfaced during the execution. @@ -23,7 +23,7 @@ package. - AAD Application with `Owner` permissions to an Azure subscription - PowerShell 7 - Node 12.x -- Azure SDK for JS [`dev-tool`](../tools/dev-tool) +- Azure SDK for JS [`dev-tool`](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/dev-tool) ## Configuring Samples diff --git a/documentation/Bundling.md b/documentation/Bundling.md index af10e646ab15..a521dacbb853 100644 --- a/documentation/Bundling.md +++ b/documentation/Bundling.md @@ -365,7 +365,7 @@ Once this is done, you can use parcel by configuring your project in the way tha ### Parcel with Javascript -Parcel uses [browserslist](https://github.com/browserslist/browserslist) to configure what polyfills are needed when bundling. Azure SDK libraries generally target the ES2015 version of JavaScript and use some modern features of JavaScript, including [generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*), so let's edit `package.json` to target the latest version of three popular browsers: +Parcel uses [browserslist](https://github.com/browserslist/browserslist) to configure what polyfills are needed when bundling. Azure SDK libraries generally target the ES2015 version of JavaScript and use some modern features of JavaScript, including [generators](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function*), so let's edit `package.json` to target the latest version of three popular browsers: ```json "browserslist": [ @@ -413,7 +413,7 @@ This will emit a compiled version of `index.html`, as well as any included scrip ### Parcel with TypeScript -Parcel uses [browserslist](https://github.com/browserslist/browserslist) to configure what polyfills are needed when bundling. The Azure SDK uses some modern features of JavaScript, including [async functions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function), so let's edit `package.json` to target the latest version of three popular browsers: +Parcel uses [browserslist](https://github.com/browserslist/browserslist) to configure what polyfills are needed when bundling. The Azure SDK uses some modern features of JavaScript, including [async functions](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/async_function), so let's edit `package.json` to target the latest version of three popular browsers: ```json "browserslist": [ diff --git a/documentation/using-azure-identity.md b/documentation/using-azure-identity.md index 46a5c364e1b9..b32edfe0b715 100644 --- a/documentation/using-azure-identity.md +++ b/documentation/using-azure-identity.md @@ -2,10 +2,10 @@ This document intends to demystify the configuration and use of [Microsoft identity -platform](https://docs.microsoft.com/en-us/azure/active-directory/develop/), +platform](https://docs.microsoft.com/azure/active-directory/develop/), also known as Azure Active Directory v2, with the Azure SDK libraries. Microsoft identity platform implements the [OAuth 2.0 and OpenID Connect -standards](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols) +standards](https://docs.microsoft.com/azure/active-directory/develop/active-directory-v2-protocols) to provide authentication for users and services who may be granted access to Azure services. @@ -26,12 +26,12 @@ tenant. A "tenant" is basically instance of Azure Active Directory associated with your Azure account. You can follow the instructions on [this quick start guide for setting up a -tenant](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant) +tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) to check if you have AAD tenant already or, if not, create one. Once you have a tenant, you can create an app registration by following [this quickstart guide for app -registrations](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app). +registrations](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app). Your app registration holds the configuration for how your application will authenticate users and services, so it's very important to it set up correctly before using any of the credential types below. The section on each credential @@ -47,7 +47,7 @@ inside of your AAD tenant or if you'd like other organizations and individuals to use it. The [app registration quickstart -guide](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app#register-a-new-application-using-the-azure-portal) +guide](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app#register-a-new-application-using-the-azure-portal) gives a helpful breakdown for the various tenancy options in the "Supported account types" documentation. @@ -62,7 +62,7 @@ serve different use cases and application types. A primary differentiator between these flows is whether the "client" that initiates the flow is running on a user device or on a system managed by the application developer (like a web server). The [Microsoft Authentication -Library](https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-client-applications) +Library](https://docs.microsoft.com/azure/active-directory/develop/msal-client-applications) documentation describes this distinction as _public_ versus _confidential_ clients. @@ -70,7 +70,7 @@ Most of the credential types are strictly public or confidential as they serve a specific purpose, like authenticating a backend service for use with storage APIs. Some credentials may be both public or confidential depending on how you configure them. For example, the [authorization code -flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow) +flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow) can be initiated from a mobile application _or_ from within a web application running in a server. @@ -106,7 +106,7 @@ environment?** The identity platform provides an authorization model for Azure services with [two types of -permissions](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent#troubleshooting-permissions-and-consent): +permissions](https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent#troubleshooting-permissions-and-consent): - **Application permissions** authorize an application to access resources directly. Administrator consent must be granted to your application. @@ -120,7 +120,7 @@ with a _public credential_, you must configure API permissions for the Azure service you need to access (Key Vault, Storage, etc) so that user accounts can be authorized to use them through your application. The [quick start guide for configuring API -permissions](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-configure-app-access-web-apis) +permissions](https://docs.microsoft.com/azure/active-directory/develop/quickstart-configure-app-access-web-apis) explains how to do this in detail. ### User-Granted Consent @@ -130,19 +130,19 @@ delegated permissions, they may be presented with a consent screen that asks whether they want to grant your application permission to access resources on their behalf. An example of this consent flow can be found in the [consent framework documentation -page](https://docs.microsoft.com/en-us/azure/active-directory/develop/consent-framework). +page](https://docs.microsoft.com/azure/active-directory/develop/consent-framework). An administrator can also grant consent for your application on behalf of all users. In this case, users may never see a consent screen. If you'd like to make it easy for an administrator to grant access to all users, follow the instructions in the [admin consent endpoint request -documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent#request-the-permissions-from-a-directory-admin). +documentation](https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent#request-the-permissions-from-a-directory-admin). There are some cases where a user may not be allowed to grant consent to an application. When this occurs, the user may have to speak with an administrator to have the permissions granted on their behalf. The [user consent troubleshooting -page](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/application-sign-in-unexpected-user-consent-error) +page](https://docs.microsoft.com/azure/active-directory/manage-apps/application-sign-in-unexpected-user-consent-error) provides more details on the consent errors a user might encounter. ## Credential Types in @azure/identity @@ -150,7 +150,7 @@ provides more details on the consent errors a user might encounter. ### ClientSecretCredential and ClientCertificateCredential The `ClientSecretCredential` implements the [client credentials -flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow) +flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow) to enable confidential clients, like web services, to access Azure resources. To use this credential, you will need to create a client secret using the "Certificates & secrets" page for your app registration. @@ -159,7 +159,7 @@ The `ClientCertificateCredential` implements the same client credentials flow, but instead uses a certificate as the means to authenticate the client. You must must generate your own PEM-formatted certificate for use in this flow and then [register -it](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad) +it](https://docs.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad) in the "Certificates & secrets" page for your app registration. Using a certificate to authenticate is recommended as it is generally more secure than using a client secret. @@ -174,7 +174,7 @@ on which credential you are using. ### UsernamePasswordCredential The `UsernamePasswordCredential` follows the [resource owner password credential -flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth-ropc) +flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth-ropc) to authenticate public or confidential clients. To use this credential, you will need the `tenantId` and `clientId` of your app and a `username` and `password` of the user you are authenticating. @@ -193,7 +193,7 @@ directly is a major security risk. > NOTE: This credential type does not work with personal Microsoft accounts or > multi-factor authentication at this time. See the -> [documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth-ropc) +> [documentation](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth-ropc) > for more information. ### EnvironmentCredential @@ -228,7 +228,7 @@ application to learn how to configure environment variables for your deployment. The `ManagedIdentityCredential` takes advantage of authentication endpoints that are hosted within the virtual network of applications deployed to Azure virtual machines, App Services, Functions, Container Services, [and -more](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities). +more](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities). One important distinction of this credential compared to the others is that it _does not require an app registration_. This authentication scheme relates to @@ -240,10 +240,10 @@ to grant one of two types of managed identity to the resource that runs your code: - A [system-assigned - identity](https://docs.microsoft.com/en-us/azure/app-service/overview-managed-identity#adding-a-system-assigned-identity) + identity](https://docs.microsoft.com/azure/app-service/overview-managed-identity#adding-a-system-assigned-identity) which uniquely identifies your resource - A [user-assigned - identity](https://docs.microsoft.com/en-us/azure/app-service/overview-managed-identity#adding-a-user-assigned-identity) + identity](https://docs.microsoft.com/azure/app-service/overview-managed-identity#adding-a-user-assigned-identity) which can be assigned to your resource (and others) Once your resource has an identity assigned, that identity can be granted access @@ -256,15 +256,15 @@ the managed identity you wish to use for authentication. More information on configuring and using managed identities can be found in the [Managed identities for Azure -resources](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview) +resources](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview) documentation. There is also a [list of Azure -services](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities#azure-services-that-support-azure-ad-authentication) +services](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities#azure-services-that-support-azure-ad-authentication) that have been tested to confirm support for managed identity authentication. ### InteractiveBrowserCredential The `InteractiveBrowserCredential` follows the [implicit grant -flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-implicit-grant-flow) +flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-implicit-grant-flow) which enables authentication for clients that run completely in the browser. It is primarily useful for single-page web applications (SPAs) which need to authenticate to access Azure resources and APIs directly. @@ -285,7 +285,7 @@ creating an `InteractiveBrowserCredential`. ### DeviceCodeCredential The `DeviceCodeCredential` follows the [device code authorization -flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-device-code) +flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-device-code) which enables input-constrained devices, like TVs or IoT devices, to authenticate by having the user enter a provided "device code" into an authorization site that the user visits on another device. @@ -297,7 +297,7 @@ section of the **Authentication** page of your app registration. ### AuthorizationCodeCredential The `AuthorizationCodeCredential` follows the [authorization code -flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow) +flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow) which enables server-hosted web applications, native desktop and mobile applications, and web APIs to access resources on the user's behalf. diff --git a/eng/pipelines/templates/steps/analyze.yml b/eng/pipelines/templates/steps/analyze.yml index 2e274370299f..923eb17dd8c4 100644 --- a/eng/pipelines/templates/steps/analyze.yml +++ b/eng/pipelines/templates/steps/analyze.yml @@ -23,6 +23,7 @@ steps: - template: ../../../common/pipelines/templates/steps/verify-links.yml parameters: Directory: sdk/${{ parameters.ServiceDirectory }} + CheckLinkGuidance: $true - script: | npm ci diff --git a/eng/pipelines/templates/steps/build.yml b/eng/pipelines/templates/steps/build.yml index 54ef9c530112..db710484e695 100644 --- a/eng/pipelines/templates/steps/build.yml +++ b/eng/pipelines/templates/steps/build.yml @@ -23,13 +23,6 @@ steps: condition: and(succeeded(),ne(variables['SetDevVersion'],'true')) displayName: "Install dependencies" - - template: /eng/common/pipelines/templates/steps/replace-relative-links.yml - parameters: - TargetFolder: $(Build.SourcesDirectory)/sdk/$(folder) - RootFolder: $(Build.SourcesDirectory) - BuildSHA: $(Build.SourceVersion) - RepoId: "Azure/azure-sdk-for-js" - # Option "-p max" ensures parallelism is set to the number of cores on all platforms, which improves build times. # The default on Windows is "cores - 1" (microsoft/rushstack#436). - script: | diff --git a/sdk/appconfiguration/app-configuration/README.md b/sdk/appconfiguration/app-configuration/README.md index 0fbe9d7c3645..2e9e3e4de436 100644 --- a/sdk/appconfiguration/app-configuration/README.md +++ b/sdk/appconfiguration/app-configuration/README.md @@ -1,6 +1,6 @@ # App Configuration client library for JavaScript -[Azure App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/overview) is a managed service that helps developers centralize their application and feature settings simply and securely. +[Azure App Configuration](https://docs.microsoft.com/azure/azure-app-configuration/overview) is a managed service that helps developers centralize their application and feature settings simply and securely. Use the client library for App Configuration to: @@ -11,7 +11,7 @@ Use the client library for App Configuration to: [Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/) | [Package (NPM)](https://www.npmjs.com/package/@azure/app-configuration) | [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/app-configuration) | -[Product documentation](https://docs.microsoft.com/en-us/azure/azure-app-configuration/) | +[Product documentation](https://docs.microsoft.com/azure/azure-app-configuration/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples) ## Getting started @@ -24,7 +24,7 @@ npm install @azure/app-configuration ### Prerequisites -- You must have an [Azure Subscription](https://azure.microsoft.com) and an [App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/) resource to use this package. +- 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 ### Create an App Configuration resource @@ -134,7 +134,7 @@ async function run() { value: "testvalue", // Labels allow you to create variants of a key tailored // for specific use-cases like supporting multiple environments. - // https://docs.microsoft.com/en-us/azure/azure-app-configuration/concept-key-value#label-keys + // https://docs.microsoft.com/azure/azure-app-configuration/concept-key-value#label-keys label: "optional-label" }); @@ -181,6 +181,6 @@ folder for more details. ## Related projects - [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js) -- [Azure App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/overview) +- [Azure App Configuration](https://docs.microsoft.com/azure/azure-app-configuration/overview) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fappconfiguration%2Fapp-configuration%2FREADME.png) diff --git a/sdk/appconfiguration/app-configuration/test/README.md b/sdk/appconfiguration/app-configuration/test/README.md index 36f4b682f04b..326060770fb5 100644 --- a/sdk/appconfiguration/app-configuration/test/README.md +++ b/sdk/appconfiguration/app-configuration/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resource that is used by the tests in this project is: -- An [Azure App Configuration](https://docs.microsoft.com/en-us/azure/azure-app-configuration/overview). Your Azure application needs to be assigned as the **owner** of this Azure App Configuration resource. The steps are provided [below](#AAD-based-authentication). +- An [Azure App Configuration](https://docs.microsoft.com/azure/azure-app-configuration/overview). Your Azure application needs to be assigned as the **owner** of this Azure App Configuration resource. The steps are provided [below](#AAD-based-authentication). To run the live tests, you will also need to set the below environment variables: @@ -25,7 +25,7 @@ The following steps will help you setup the AAD credentials. ### Register a new application in AAD -- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). +- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). - Note down the `CLIENT_ID` and `TENANT_ID`. - In the "Certificates & Secrets" tab, create a secret and note that down. @@ -34,6 +34,6 @@ The following steps will help you setup the AAD credentials. - In the Azure portal, go to your Azure App Configuration and assign the **Owner** role to the registered application. - This can be done from `Role assignment` section of `Access control (IAM)` tab (in the left-side-navbar of your Azure App Configuration in the Azure portal)
_Doing this would allow the registered application manage the resource, i.e., entity creation, deletion, etc.,_
-- For more information on securing your Azure App Configuration: [Learn more](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-event-hubs) +- For more information on securing your Azure App Configuration: [Learn more](https://docs.microsoft.com/azure/event-hubs/authorize-access-event-hubs) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fappconfiguration%2Fapp-configuration%2Ftest%2FREADME.png) diff --git a/sdk/cognitiveservices/cognitiveservices-anomalydetector/README.md b/sdk/cognitiveservices/cognitiveservices-anomalydetector/README.md index ab8ee82f328d..324f5088e7b0 100644 --- a/sdk/cognitiveservices/cognitiveservices-anomalydetector/README.md +++ b/sdk/cognitiveservices/cognitiveservices-anomalydetector/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample determines anamolies with the given time series. To know more, refer to the [Azure Documentation on Anomaly Detectors](https://docs.microsoft.com/en-us/azure/cognitive-services/anomaly-detector/) +The following sample determines anamolies with the given time series. To know more, refer to the [Azure Documentation on Anomaly Detectors](https://docs.microsoft.com/azure/cognitive-services/anomaly-detector/) ```javascript const { AnomalyDetectorClient } = require("@azure/cognitiveservices-anomalydetector"); diff --git a/sdk/cognitiveservices/cognitiveservices-autosuggest/README.md b/sdk/cognitiveservices/cognitiveservices-autosuggest/README.md index fcaa3fdd2575..a89833079014 100644 --- a/sdk/cognitiveservices/cognitiveservices-autosuggest/README.md +++ b/sdk/cognitiveservices/cognitiveservices-autosuggest/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample gets suggestions from Bing for the given query **Microsoft Azure**. To know more, refer to the [Azure Documentation on Bing Auto Suggest](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-autosuggest/) +The following sample gets suggestions from Bing for the given query **Microsoft Azure**. To know more, refer to the [Azure Documentation on Bing Auto Suggest](https://docs.microsoft.com/azure/cognitive-services/bing-autosuggest/) ```javascript const { AutoSuggestClient } = require("@azure/cognitiveservices-autosuggest"); diff --git a/sdk/cognitiveservices/cognitiveservices-computervision/README.md b/sdk/cognitiveservices/cognitiveservices-computervision/README.md index ac8de3afbaff..e4067518d8f2 100644 --- a/sdk/cognitiveservices/cognitiveservices-computervision/README.md +++ b/sdk/cognitiveservices/cognitiveservices-computervision/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample describes a given image using Computer Vision. To know more, refer to the [Azure Documentation on Computer Vision](https://docs.microsoft.com/en-us/azure/cognitive-services/computer-vision/home) +The following sample describes a given image using Computer Vision. To know more, refer to the [Azure Documentation on Computer Vision](https://docs.microsoft.com/azure/cognitive-services/computer-vision/home) ```javascript const { ComputerVisionClient } = require("@azure/cognitiveservices-computervision"); @@ -38,7 +38,7 @@ async function main() { const client = new ComputerVisionClient(cognitiveServiceCredentials, computerVisionEndPoint); const url = - "https://docs.microsoft.com/en-us/azure/includes/media/shared-image-galleries/shared-image-gallery.png"; + "https://docs.microsoft.com/azure/includes/media/shared-image-galleries/shared-image-gallery.png"; const options = { maxCandidates: 5, language: "en" @@ -85,7 +85,7 @@ main(); ); const url = - "https://docs.microsoft.com/en-us/azure/includes/media/shared-image-galleries/shared-image-gallery.png"; + "https://docs.microsoft.com/azure/includes/media/shared-image-galleries/shared-image-gallery.png"; const options = { maxCandidates: 5, language: "en" diff --git a/sdk/cognitiveservices/cognitiveservices-contentmoderator/README.md b/sdk/cognitiveservices/cognitiveservices-contentmoderator/README.md index 66686180ab95..675c7e9e6cbc 100644 --- a/sdk/cognitiveservices/cognitiveservices-contentmoderator/README.md +++ b/sdk/cognitiveservices/cognitiveservices-contentmoderator/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample detects the langauge of text provided using text moderator APIs. To know more, refer to the [Azure Documentation on Content Moderator](https://docs.microsoft.com/en-us/azure/cognitive-services/content-moderator/overview) +The following sample detects the langauge of text provided using text moderator APIs. To know more, refer to the [Azure Documentation on Content Moderator](https://docs.microsoft.com/azure/cognitive-services/content-moderator/overview) ```javascript const { ContentModeratorClient } = require("@azure/cognitiveservices-contentmoderator"); diff --git a/sdk/cognitiveservices/cognitiveservices-customimagesearch/README.md b/sdk/cognitiveservices/cognitiveservices-customimagesearch/README.md index 9f7975ddcc49..fa09f23ffd87 100644 --- a/sdk/cognitiveservices/cognitiveservices-customimagesearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-customimagesearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs an image search for given query on a custom configuration. The custom configuration can be setup using the Custom search portal. To know more, refer to the [Azure Documentation on Bing Custom Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-custom-search/) +The following sample performs an image search for given query on a custom configuration. The custom configuration can be setup using the Custom search portal. To know more, refer to the [Azure Documentation on Bing Custom Search](https://docs.microsoft.com/azure/cognitive-services/bing-custom-search/) ```javascript const { CustomImageSearchClient } = require("@azure/cognitiveservices-customimagesearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-customsearch/README.md b/sdk/cognitiveservices/cognitiveservices-customsearch/README.md index e9ba05319682..b0279049acc4 100644 --- a/sdk/cognitiveservices/cognitiveservices-customsearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-customsearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs a search for given query on a custom configuration. The custom configuration can be setup using the Custom search portal. To know more, refer to the [Azure Documentation Bing Custom Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-custom-search/) +The following sample performs a search for given query on a custom configuration. The custom configuration can be setup using the Custom search portal. To know more, refer to the [Azure Documentation Bing Custom Search](https://docs.microsoft.com/azure/cognitive-services/bing-custom-search/) ```javascript const { CustomSearchClient } = require("@azure/cognitiveservices-customsearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-customvision-prediction/README.md b/sdk/cognitiveservices/cognitiveservices-customvision-prediction/README.md index 8c5f3297f711..c77450f79c73 100644 --- a/sdk/cognitiveservices/cognitiveservices-customvision-prediction/README.md +++ b/sdk/cognitiveservices/cognitiveservices-customvision-prediction/README.md @@ -18,7 +18,7 @@ npm install @azure/cognitiveservices-customvision-prediction #### nodejs - Authentication, client creation and classifyImageUrl as an example written in TypeScript. ##### Sample code -The following sample predicts and classifies the given image based on your custom vision training. To know more, refer to the [Azure Documentation on Custom Vision Services](https://docs.microsoft.com/en-us/azure/cognitive-services/custom-vision-service/home). +The following sample predicts and classifies the given image based on your custom vision training. To know more, refer to the [Azure Documentation on Custom Vision Services](https://docs.microsoft.com/azure/cognitive-services/custom-vision-service/home). ```javascript const { PredictionAPIClient } = require("@azure/cognitiveservices-customvision-prediction"); diff --git a/sdk/cognitiveservices/cognitiveservices-customvision-training/README.md b/sdk/cognitiveservices/cognitiveservices-customvision-training/README.md index ad6fd5500992..b80ad980a2c9 100644 --- a/sdk/cognitiveservices/cognitiveservices-customvision-training/README.md +++ b/sdk/cognitiveservices/cognitiveservices-customvision-training/README.md @@ -18,7 +18,7 @@ npm install @azure/cognitiveservices-customvision-training #### nodejs - Authentication, client creation and getDomains as an example written in TypeScript. ##### Sample code -The following sample performs a quick test of the given image based on your custom vision training. To know more, refer to the [Azure Documentation on Custom Vision Services](https://docs.microsoft.com/en-us/azure/cognitive-services/custom-vision-service/home). +The following sample performs a quick test of the given image based on your custom vision training. To know more, refer to the [Azure Documentation on Custom Vision Services](https://docs.microsoft.com/azure/cognitive-services/custom-vision-service/home). ```javascript const { TrainingAPIClient } = require("@azure/cognitiveservices-customvision-training"); diff --git a/sdk/cognitiveservices/cognitiveservices-entitysearch/README.md b/sdk/cognitiveservices/cognitiveservices-entitysearch/README.md index 239d2dd110ef..0ff80a675085 100644 --- a/sdk/cognitiveservices/cognitiveservices-entitysearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-entitysearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs a Bing entity search on the query 'Microsoft Azure'. To know more, refer to the [Azure Documentation on Bing Entities Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-entities-search/). +The following sample performs a Bing entity search on the query 'Microsoft Azure'. To know more, refer to the [Azure Documentation on Bing Entities Search](https://docs.microsoft.com/azure/cognitive-services/bing-entities-search/). ```javascript const { EntitySearchClient } = require("@azure/cognitiveservices-entitysearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-face/README.md b/sdk/cognitiveservices/cognitiveservices-face/README.md index 70aa7c627b16..343c6a481fcb 100644 --- a/sdk/cognitiveservices/cognitiveservices-face/README.md +++ b/sdk/cognitiveservices/cognitiveservices-face/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample detects the facial features on the given image. To know more, refer to the [Azure Documentation on Face APIs](https://docs.microsoft.com/en-us/azure/cognitive-services/face/overview) +The following sample detects the facial features on the given image. To know more, refer to the [Azure Documentation on Face APIs](https://docs.microsoft.com/azure/cognitive-services/face/overview) ```javascript const { FaceClient, FaceModels } = require("@azure/cognitiveservices-face"); diff --git a/sdk/cognitiveservices/cognitiveservices-formrecognizer/README.md b/sdk/cognitiveservices/cognitiveservices-formrecognizer/README.md index c5733dce02a3..34713e316ae2 100644 --- a/sdk/cognitiveservices/cognitiveservices-formrecognizer/README.md +++ b/sdk/cognitiveservices/cognitiveservices-formrecognizer/README.md @@ -25,7 +25,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample reads the scanned copy of a sample receipt. To know more, refer to the [Azure Documentation on Form Recognizer](https://docs.microsoft.com/en-us/azure/cognitive-services/form-recognizer/overview) +The following sample reads the scanned copy of a sample receipt. To know more, refer to the [Azure Documentation on Form Recognizer](https://docs.microsoft.com/azure/cognitive-services/form-recognizer/overview) ```javascript const { FormRecognizerClient } = require("@azure/cognitiveservices-formrecognizer"); diff --git a/sdk/cognitiveservices/cognitiveservices-imagesearch/README.md b/sdk/cognitiveservices/cognitiveservices-imagesearch/README.md index b057feeb6bd8..4cca4e181aa7 100644 --- a/sdk/cognitiveservices/cognitiveservices-imagesearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-imagesearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs an image search for 'Microsoft Azure' with conditions such as the color has to be 'Monochrome', etc. To know more, refer to the [Azure Documentation on Bing Image Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-image-search/) +The following sample performs an image search for 'Microsoft Azure' with conditions such as the color has to be 'Monochrome', etc. To know more, refer to the [Azure Documentation on Bing Image Search](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/) ```javascript const { ImageSearchClient } = require("@azure/cognitiveservices-imagesearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-localsearch/README.md b/sdk/cognitiveservices/cognitiveservices-localsearch/README.md index 6efb2cc4c7ca..1807e8d9e6d3 100644 --- a/sdk/cognitiveservices/cognitiveservices-localsearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-localsearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs an local business search with the query 'Coffee 98052'. To know more, refer to the [Azure Documentation on Bing Local Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-local-business-search/) +The following sample performs an local business search with the query 'Coffee 98052'. To know more, refer to the [Azure Documentation on Bing Local Search](https://docs.microsoft.com/azure/cognitive-services/bing-local-business-search/) ```javascript const { LocalSearchClient } = require("@azure/cognitiveservices-localsearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-luis-authoring/README.md b/sdk/cognitiveservices/cognitiveservices-luis-authoring/README.md index 73d1087aeca6..7c5bfb93e503 100644 --- a/sdk/cognitiveservices/cognitiveservices-luis-authoring/README.md +++ b/sdk/cognitiveservices/cognitiveservices-luis-authoring/README.md @@ -38,7 +38,7 @@ let authoringKey = process.env["luis-authoring-key"]; const creds = new CognitiveServicesCredentials(authoringKey); // check the following link to find your region -// https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions +// https://docs.microsoft.com/azure/cognitive-services/luis/luis-reference-regions const region = ""; const client = new LUISAuthoringClient( creds, diff --git a/sdk/cognitiveservices/cognitiveservices-luis-runtime/README.md b/sdk/cognitiveservices/cognitiveservices-luis-runtime/README.md index 79401dd898b8..9e49103ae3a1 100644 --- a/sdk/cognitiveservices/cognitiveservices-luis-runtime/README.md +++ b/sdk/cognitiveservices/cognitiveservices-luis-runtime/README.md @@ -33,7 +33,7 @@ let authoringKey = process.env["luis-authoring-key"]; const creds = new CognitiveServicesCredentials(authoringKey); // check the following link to find your region -// https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions +// https://docs.microsoft.com/azure/cognitive-services/luis/luis-reference-regions const region = ""; const client = new LUISRuntimeClient(creds, "https://" + region + ".api.cognitive.microsoft.com/"); @@ -103,7 +103,7 @@ client.prediction // check the following link to find your region - // https://docs.microsoft.com/en-us/azure/cognitive-services/luis/luis-reference-regions + // https://docs.microsoft.com/azure/cognitive-services/luis/luis-reference-regions const region = ""; const client = new Azure.CognitiveservicesLuisRuntime.LUISRuntimeClient( creds, diff --git a/sdk/cognitiveservices/cognitiveservices-newssearch/README.md b/sdk/cognitiveservices/cognitiveservices-newssearch/README.md index edfd67088a2b..4fdb76150b9f 100644 --- a/sdk/cognitiveservices/cognitiveservices-newssearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-newssearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs a news search on 'Microsoft Azure' with conditions such as the freshness must be within a Month, etc. To know more, refer to the [Azure Documentation on Bing News Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/) +The following sample performs a news search on 'Microsoft Azure' with conditions such as the freshness must be within a Month, etc. To know more, refer to the [Azure Documentation on Bing News Search](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/) ```javascript const { NewsSearchClient } = require("@azure/cognitiveservices-newssearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-personalizer/README.md b/sdk/cognitiveservices/cognitiveservices-personalizer/README.md index 751a43fe9d7e..f96361cdb7d1 100644 --- a/sdk/cognitiveservices/cognitiveservices-personalizer/README.md +++ b/sdk/cognitiveservices/cognitiveservices-personalizer/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample ranks a personalized request object. To know more, refer to the [Azure Documentation on Personalizer](https://docs.microsoft.com/en-us/azure/cognitive-services/personalizer/) +The following sample ranks a personalized request object. To know more, refer to the [Azure Documentation on Personalizer](https://docs.microsoft.com/azure/cognitive-services/personalizer/) ```javascript const { PersonalizerClient } = require("@azure/cognitiveservices-personalizer"); diff --git a/sdk/cognitiveservices/cognitiveservices-spellcheck/README.md b/sdk/cognitiveservices/cognitiveservices-spellcheck/README.md index 2c03234aaf84..5d27845f565a 100644 --- a/sdk/cognitiveservices/cognitiveservices-spellcheck/README.md +++ b/sdk/cognitiveservices/cognitiveservices-spellcheck/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs a spell check on the text - 'Bill Gatos'. The result will return a suggestion of 'Gates'. To know more, refer to the [Azure Documentation on Spell Check](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-spell-check/) +The following sample performs a spell check on the text - 'Bill Gatos'. The result will return a suggestion of 'Gates'. To know more, refer to the [Azure Documentation on Spell Check](https://docs.microsoft.com/azure/cognitive-services/bing-spell-check/) ```javascript const { SpellCheckClient } = require("@azure/cognitiveservices-spellcheck"); diff --git a/sdk/cognitiveservices/cognitiveservices-textanalytics/README.md b/sdk/cognitiveservices/cognitiveservices-textanalytics/README.md index 5420a1c3de5d..905442972f0d 100644 --- a/sdk/cognitiveservices/cognitiveservices-textanalytics/README.md +++ b/sdk/cognitiveservices/cognitiveservices-textanalytics/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample detects the langauge in the provided text. In addition, it provides data such as Characters count, transaction count, etc. To know more, refer to the [Azure Documentation on Text Analytics](https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview) +The following sample detects the langauge in the provided text. In addition, it provides data such as Characters count, transaction count, etc. To know more, refer to the [Azure Documentation on Text Analytics](https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview) ```javascript const { TextAnalyticsClient } = require("@azure/cognitiveservices-textanalytics"); diff --git a/sdk/cognitiveservices/cognitiveservices-translatortext/README.md b/sdk/cognitiveservices/cognitiveservices-translatortext/README.md index 4fa7533bb4bd..ca96ca922c45 100644 --- a/sdk/cognitiveservices/cognitiveservices-translatortext/README.md +++ b/sdk/cognitiveservices/cognitiveservices-translatortext/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample translates the given text which is in Chinese to English. To know more, refer to the [Azure Documentation on Translator](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/) +The following sample translates the given text which is in Chinese to English. To know more, refer to the [Azure Documentation on Translator](https://docs.microsoft.com/azure/cognitive-services/translator/) ```javascript const { TranslatorTextClient } = require("@azure/cognitiveservices-translatortext"); diff --git a/sdk/cognitiveservices/cognitiveservices-videosearch/README.md b/sdk/cognitiveservices/cognitiveservices-videosearch/README.md index dcd67e5871dd..443f4626ce92 100644 --- a/sdk/cognitiveservices/cognitiveservices-videosearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-videosearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs a video search on 'Microsoft Azure' with conditions such as the length must be Short, pricing must be Free, etc. To know more, refer to the [Azure Documentation on Bing Video Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-video-search/) +The following sample performs a video search on 'Microsoft Azure' with conditions such as the length must be Short, pricing must be Free, etc. To know more, refer to the [Azure Documentation on Bing Video Search](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/) ```javascript const { VideoSearchClient } = require("@azure/cognitiveservices-videosearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-visualsearch/README.md b/sdk/cognitiveservices/cognitiveservices-visualsearch/README.md index 95527ab6761e..a19902674acc 100644 --- a/sdk/cognitiveservices/cognitiveservices-visualsearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-visualsearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs a visual search, i.e. perform a search with a image. To know more, refer to the [Azure Documentation on Bing Visual Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/). +The following sample performs a visual search, i.e. perform a search with a image. To know more, refer to the [Azure Documentation on Bing Visual Search](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/). ```javascript const { VisualSearchClient } = require("@azure/cognitiveservices-visualsearch"); diff --git a/sdk/cognitiveservices/cognitiveservices-websearch/README.md b/sdk/cognitiveservices/cognitiveservices-websearch/README.md index 7ff651d1d7a3..dcca110c07d1 100644 --- a/sdk/cognitiveservices/cognitiveservices-websearch/README.md +++ b/sdk/cognitiveservices/cognitiveservices-websearch/README.md @@ -24,7 +24,7 @@ npm install @azure/ms-rest-azure-js ``` ##### Sample code -The following sample performs a web search on the text 'Microsoft Azure'. To know more, refer to the [Azure Documentation on Bing Web Search](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-web-search/) +The following sample performs a web search on the text 'Microsoft Azure'. To know more, refer to the [Azure Documentation on Bing Web Search](https://docs.microsoft.com/azure/cognitive-services/bing-web-search/) ```javascript const { WebSearchClient } = require("@azure/cognitiveservices-websearch"); diff --git a/sdk/core/core-amqp/CHANGELOG.md b/sdk/core/core-amqp/CHANGELOG.md index 835a430d12e5..2371df6f4a85 100644 --- a/sdk/core/core-amqp/CHANGELOG.md +++ b/sdk/core/core-amqp/CHANGELOG.md @@ -91,7 +91,7 @@ Updates types for better compatibility with TypeScript 3.6.x. (PR #4928) This library is based off of the [@azure/amqp-common](https://www.npmjs.com/package/@azure/amqp-common) library. Both are meant to contain common functionality required by Azure Javascript libraries that -use the [AMQP protocol](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-amqp-protocol-guide) +use the [AMQP protocol](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-amqp-protocol-guide) like the ones for Azure Service Bus and Azure Event Hubs. Key differences between this library and the older @azure/amqp-common are: diff --git a/sdk/core/core-amqp/README.md b/sdk/core/core-amqp/README.md index f6115f3d0f72..3805240998b4 100644 --- a/sdk/core/core-amqp/README.md +++ b/sdk/core/core-amqp/README.md @@ -1,7 +1,7 @@ # Azure Core AMQP client library for AMQP operations Azure Core AMQP is a library that provides common functionality for **Azure** Javascript -libraries that use [AMQP protocol](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-amqp-protocol-guide) +libraries that use [AMQP protocol](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-amqp-protocol-guide) like the ones for Azure Service Bus and Azure Event Hubs. ## Getting started @@ -21,15 +21,15 @@ in your application. Some of the key features of Azure Core AMQP library are: -- [Claims based Authorization](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-amqp-protocol-guide#claims-based-authorization) -- Request-Response link for [sending request and receiving response over AMQP](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-amqp-protocol-guide#amqp-management) +- [Claims based Authorization](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-amqp-protocol-guide#claims-based-authorization) +- Request-Response link for [sending request and receiving response over AMQP](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-amqp-protocol-guide#amqp-management) - A Data Transformer class to encode given data to an AMQP message and decode a given AMQP message. Useful for sending and receiving messages that are not of type Buffer. - Error translation of AMQP error codes along with errors specific to Azure Service Bus and Azure Event Hubs. - RetryPolicy for retrying a given operation if a retryable error was encountered. ## Examples -[Claims Based Authorization](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-amqp-protocol-guide#claims-based-authorization) +[Claims Based Authorization](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-amqp-protocol-guide#claims-based-authorization) need to be done for every AMQP link that your application creates. The claims also has to be renewed periodically. For more details on CBS, please see the [CBS Specification](https://www.oasis-open.org/committees/download.php/62097/amqp-cbs-v1.0-wd05.doc). @@ -257,7 +257,7 @@ When you submit a pull request, a CLA-bot will automatically determine whether y a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. -If you'd like to contribute to this library, please read the [contributing guide](../../../CONTRIBUTING.md) to learn more about how to build and test the code. +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. This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or diff --git a/sdk/core/core-arm/README.md b/sdk/core/core-arm/README.md index 374a47173d77..73978793e731 100644 --- a/sdk/core/core-arm/README.md +++ b/sdk/core/core-arm/README.md @@ -47,7 +47,7 @@ When you submit a pull request, a CLA-bot will automatically determine whether y a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. -If you'd like to contribute to this library, please read the [contributing guide](../../../CONTRIBUTING.md) to learn more about how to build and test the code. +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. This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or diff --git a/sdk/core/core-lro/README.md b/sdk/core/core-lro/README.md index 952510449bdd..8958ceda3603 100644 --- a/sdk/core/core-lro/README.md +++ b/sdk/core/core-lro/README.md @@ -6,7 +6,7 @@ `@azure/core-lro` is made following our [Long Running Operations guidelines](https://azure.github.io/azure-sdk/typescript_design.html#ts-lro) -[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro) | [Package (npm)](https://www.npmjs.com/package/@azure/core-lro) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/core-lro) | [Samples](./samples) +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro) | [Package (npm)](https://www.npmjs.com/package/@azure/core-lro) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/core-lro) | [Samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples) ## Getting started @@ -68,7 +68,7 @@ Packages inside of [azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js) ## Next steps -Please take a look at the [samples](./samples) directory for detailed examples on how to use this library. +Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples) directory for detailed examples on how to use this library. ## Contributing diff --git a/sdk/core/core-lro/samples/README.md b/sdk/core/core-lro/samples/README.md index 714e0554955f..7842239a0a2e 100644 --- a/sdk/core/core-lro/samples/README.md +++ b/sdk/core/core-lro/samples/README.md @@ -8,7 +8,7 @@ In this folder you will be able to see a simple sample file implementing a `Poll The sample file: -- [typescript/samplesClient.ts](./typescript/samplesClient.ts) +- [typescript/samplesClient.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples/typescript/samplesClient.ts) ## Guide on implementing a LRO method @@ -73,7 +73,7 @@ A guide on how to write them follows. The `update` method defines how to request the remote service for updates on the status of the long running operation. -It optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](../../abort-controller)'s `AbortSignalLike`. +It optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/abort-controller)'s `AbortSignalLike`. A more advanced use allows passing in a `fireProgress` function, which, if called, is responsible for triggering the poller's `onProgress` callbacks. @@ -112,7 +112,7 @@ async function update( The operation's `cancel` method should attempt to cancel the pending operation, if it's allowed by the remote service. Otherwise, it should throw. -It only optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](../../abort-controller)'s `AbortSignalLike`. +It only optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/abort-controller)'s `AbortSignalLike`. It returns a promise that should be resolved with an updated version of the poller's operation. diff --git a/sdk/cosmosdb/cosmos/CHANGELOG.md b/sdk/cosmosdb/cosmos/CHANGELOG.md index 18cc6ff82c44..6a31f4605946 100644 --- a/sdk/cosmosdb/cosmos/CHANGELOG.md +++ b/sdk/cosmosdb/cosmos/CHANGELOG.md @@ -276,7 +276,7 @@ Fixes broken session tokens in the browser. Cosmos uses file system friendly bas - DISTINCT queries - LIMIT/OFFSET queries - 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) +- Update to the latest Cosmos REST API version where [all containers have unlimited scale](https://docs.microsoft.com/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://azure.github.io/azure-sdk/typescript_introduction.html) @@ -350,7 +350,7 @@ container.items.query('SELECT * from c WHERE c.yourPartitionKey = "foo"').fetchA #### Fixed Containers are now Paritioned (#308) -[The Cosmos service now supports partition keys on all containers, including those that were previously created as fixed containers](https://docs.microsoft.com/en-us/azure/cosmos-db/migrate-containers-partitioned-to-nonpartitioned). The v3 SDK updates to the latest API version that implements this change, but it is not breaking. If you do not supply a partition key for operations, we will default to a system key that works with all your existing containers and documents. +[The Cosmos service now supports partition keys on all containers, including those that were previously created as fixed containers](https://docs.microsoft.com/azure/cosmos-db/migrate-containers-partitioned-to-nonpartitioned). The v3 SDK updates to the latest API version that implements this change, but it is not breaking. If you do not supply a partition key for operations, we will default to a system key that works with all your existing containers and documents. #### `upsert` removed for Stored Procedures (#356) diff --git a/sdk/cosmosdb/cosmos/Contributing.md b/sdk/cosmosdb/cosmos/Contributing.md index 4e2d3191db38..30dc8b90a1c1 100644 --- a/sdk/cosmosdb/cosmos/Contributing.md +++ b/sdk/cosmosdb/cosmos/Contributing.md @@ -1 +1 @@ -Please read the contributing guidelines from the [Azure Team](https://azure.microsoft.com/en-us/blog/simple-contribution-to-azure-documentation-and-sdk/) +Please read the contributing guidelines from the [Azure Team](https://azure.microsoft.com/blog/simple-contribution-to-azure-documentation-and-sdk/) diff --git a/sdk/cosmosdb/cosmos/README.md b/sdk/cosmosdb/cosmos/README.md index 7dcfb3bd8aaa..1438b14360f7 100644 --- a/sdk/cosmosdb/cosmos/README.md +++ b/sdk/cosmosdb/cosmos/README.md @@ -10,7 +10,7 @@ Azure Cosmos DB is a globally distributed, multi-model database service that sup - Create, read, update, and delete the items (JSON documents) in your containers - Query the documents in your database using SQL-like syntax -[Package (npm)][npm] | [API reference documentation](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/?view=azure-node-lates) | [Product documentation][cosmos_docs] +[Package (npm)][npm] | [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/cosmos/?view=azure-node-lates) | [Product documentation][cosmos_docs] ## Getting started @@ -49,7 +49,7 @@ az cosmosdb list-keys --resource-group --name { For simplicity we have included the `key` and `endpoint` directly in the code but you will likely want to load these from a file not in source control using a project such as [dotenv](https://www.npmjs.com/package/dotenv) or loading from environment variables -In production environments, secrets like keys should be stored in [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/) +In production environments, secrets like keys should be stored in [Azure Key Vault](https://azure.microsoft.com/services/key-vault/) ## Key concepts -Once you've initialized a [CosmosClient](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-lates), you can interact with the primary resource types in Cosmos DB: +Once you've initialized a [CosmosClient](https://docs.microsoft.com/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-lates), you can interact with the primary resource types in Cosmos DB: -- [Database](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/database?view=azure-node-latest): A Cosmos DB account can contain multiple databases. When you create a database, you specify the API you'd like to use when interacting with its documents: SQL, MongoDB, Gremlin, Cassandra, or Azure Table. Use the [Database](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/database?view=azure-node-latest) object to manage its containers. +- [Database](https://docs.microsoft.com/javascript/api/@azure/cosmos/database?view=azure-node-latest): A Cosmos DB account can contain multiple databases. When you create a database, you specify the API you'd like to use when interacting with its documents: SQL, MongoDB, Gremlin, Cassandra, or Azure Table. Use the [Database](https://docs.microsoft.com/javascript/api/@azure/cosmos/database?view=azure-node-latest) object to manage its containers. -- [Container](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/container?view=azure-node-latest): A container is a collection of JSON documents. You create (insert), read, update, and delete items in a container by using methods on the [Container](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/container?view=azure-node-latest) object. +- [Container](https://docs.microsoft.com/javascript/api/@azure/cosmos/container?view=azure-node-latest): A container is a collection of JSON documents. You create (insert), read, update, and delete items in a container by using methods on the [Container](https://docs.microsoft.com/javascript/api/@azure/cosmos/container?view=azure-node-latest) object. -- [Item](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/item?view=azure-node-latest): An Item is a JSON document stored in a container. Each Item must include an `id` key with a value that uniquely identifies the item within the container. If you do not provide an `id`, the SDK will generate one automatically. +- [Item](https://docs.microsoft.com/javascript/api/@azure/cosmos/item?view=azure-node-latest): An Item is a JSON document stored in a container. Each Item must include an `id` key with a value that uniquely identifies the item within the container. If you do not provide an `id`, the SDK will generate one automatically. For more information about these resources, see [Working with Azure Cosmos databases, containers and items][cosmos_resources]. @@ -96,7 +96,7 @@ The following sections provide several code snippets covering some of the most c ### Create a database -After authenticating your [CosmosClient](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-latest), you can work with any resource in the account. The code snippet below creates a SQL API database. +After authenticating your [CosmosClient](https://docs.microsoft.com/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-latest), you can work with any resource in the account. The code snippet below creates a SQL API database. ```js const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); @@ -114,7 +114,7 @@ console.log(container.id); ### Insert items -To insert items into a container, pass an object containing your data to [Items.upsert](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/items?view=azure-node-latest#upsert-t--requestoptions-). The Cosmos DB service requires each item has an `id` key. If you do not provide one, the SDK will generate an `id` automatically. +To insert items into a container, pass an object containing your data to [Items.upsert](https://docs.microsoft.com/javascript/api/@azure/cosmos/items?view=azure-node-latest#upsert-t--requestoptions-). The Cosmos DB service requires each item has an `id` key. If you do not provide one, the SDK will generate an `id` automatically. This example inserts several items into the container @@ -131,7 +131,7 @@ for (const city of cities) { ### Read an item -To read a single item from a container, use [Item.read](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/item?view=azure-node-latest#read-requestoptions-). This is a less expensive operation than using SQL to query by `id`. +To read a single item from a container, use [Item.read](https://docs.microsoft.com/javascript/api/@azure/cosmos/item?view=azure-node-latest#read-requestoptions-). This is a less expensive operation than using SQL to query by `id`. ```js await container.item("1").read(); @@ -139,7 +139,7 @@ await container.item("1").read(); ### Delete an item -To delete items from a container, use [Item.delete](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/item?view=azure-node-latest#delete-requestoptions-). +To delete items from a container, use [Item.delete](https://docs.microsoft.com/javascript/api/@azure/cosmos/item?view=azure-node-latest#delete-requestoptions-). ```js // Delete the first item returned by the query above @@ -148,7 +148,7 @@ await container.item("1").delete(); ### Query the database -A Cosmos DB SQL API database supports querying the items in a container with [Items.query](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-) using SQL-like syntax: +A Cosmos DB SQL API database supports querying the items in a container with [Items.query](https://docs.microsoft.com/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-) using SQL-like syntax: ```js const { resources } = await container.items @@ -159,7 +159,7 @@ for (const city of resources) { } ``` -Perform parameterized queries by passing an object containing the parameters and their values to [Items.query](https://docs.microsoft.com/en-us/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-): +Perform parameterized queries by passing an object containing the parameters and their values to [Items.query](https://docs.microsoft.com/javascript/api/@azure/cosmos/items?view=azure-node-latest#query-string---sqlqueryspec--feedoptions-): ```js const { resources } = await container.items @@ -226,14 +226,14 @@ For more extensive documentation on the Cosmos DB service, see the [Azure Cosmos ## Useful links -- [Welcome to Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/community) -- [Quick start](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-nodejs-get-started) -- [Tutorial](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-nodejs-application) +- [Welcome to Azure Cosmos DB](https://docs.microsoft.com/azure/cosmos-db/community) +- [Quick start](https://docs.microsoft.com/azure/cosmos-db/sql-api-nodejs-get-started) +- [Tutorial](https://docs.microsoft.com/azure/cosmos-db/sql-api-nodejs-application) - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/cosmosdb/cosmos/samples) -- [Introduction to Resource Model of Azure Cosmos DB Service](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-resources) -- [Introduction to SQL API of Azure Cosmos DB Service](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-sql-query) -- [Partitioning](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-partition-data) -- [API Documentation](https://docs.microsoft.com/en-us/javascript/api/%40azure/cosmos/?view=azure-node-latest) +- [Introduction to Resource Model of Azure Cosmos DB Service](https://docs.microsoft.com/azure/cosmos-db/sql-api-resources) +- [Introduction to SQL API of Azure Cosmos DB Service](https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query) +- [Partitioning](https://docs.microsoft.com/azure/cosmos-db/sql-api-partition-data) +- [API Documentation](https://docs.microsoft.com/javascript/api/%40azure/cosmos/?view=azure-node-latest) ## Contributing diff --git a/sdk/digitaltwins/digital-twins/README.md b/sdk/digitaltwins/digital-twins/README.md index d110f6d2c591..cc2ec3e6f55d 100644 --- a/sdk/digitaltwins/digital-twins/README.md +++ b/sdk/digitaltwins/digital-twins/README.md @@ -114,7 +114,7 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to ## Key concepts Azure Digital Twins Preview is an Azure IoT service that creates comprehensive models of the physical environment. It can create spatial intelligence graphs to model the relationships and interactions between people, spaces, and devices. -You can learn more about Azure Digital Twins by visiting [Azure Digital Twins Documentation](https://docs.microsoft.com/en-us/azure/digital-twins/) +You can learn more about Azure Digital Twins by visiting [Azure Digital Twins Documentation](https://docs.microsoft.com/azure/digital-twins/) ## Examples diff --git a/sdk/digitaltwins/digital-twins/samples/Readme.md b/sdk/digitaltwins/digital-twins/samples/Readme.md index 74e28f8578c8..4d337bf520b4 100644 --- a/sdk/digitaltwins/digital-twins/samples/Readme.md +++ b/sdk/digitaltwins/digital-twins/samples/Readme.md @@ -2,7 +2,7 @@ Azure Digital Twins is a developer platform for next-generation IoT solutions that lets you create, run, and manage digital representations of your business environment, securely and efficiently in the cloud. With Azure Digital Twins, creating live operational state representations is quick and cost-effective, and digital representations stay current with real-time data from IoT and other data sources. If you are new to Azure Digital Twins and would like to learn more about the platform, please make sure you check out the Azure Digital Twins [official documentation page](https://docs.microsoft.com/azure/digital-twins/overview). -For an introduction on how to program against the Azure Digital Twins service, visit the [coding tutorial page](https://docs.microsoft.com/en-us/azure/digital-twins/tutorial-code) for an easy step-by-step guide. Visit [this tutorial](https://docs.microsoft.com/azure/digital-twins/tutorial-command-line-app) to learn how to interact with an Azure Digital Twin instance using a command-line client application. Finally, for a quick guide on how to build an end-to-end Azure Digital Twins solution that is driven by live data from your environment, make sure you check out [this helpful guide](https://docs.microsoft.com/azure/digital-twins/tutorial-end-to-end). +For an introduction on how to program against the Azure Digital Twins service, visit the [coding tutorial page](https://docs.microsoft.com/azure/digital-twins/tutorial-code) for an easy step-by-step guide. Visit [this tutorial](https://docs.microsoft.com/azure/digital-twins/tutorial-command-line-app) to learn how to interact with an Azure Digital Twin instance using a command-line client application. Finally, for a quick guide on how to build an end-to-end Azure Digital Twins solution that is driven by live data from your environment, make sure you check out [this helpful guide](https://docs.microsoft.com/azure/digital-twins/tutorial-end-to-end). The guides mentioned above can help you get started with key elements of Azure Digital Twins, such as creating Azure Digital Twins instances, models, twin graphs, etc. Use this samples guide below to familiarize yourself with the various APIs that help you program against Azure Digital Twins. @@ -24,8 +24,8 @@ The samples project demonstrates the following: To create a new digital twins client, you need the endpoint to an Azure Digital Twin instance and credentials. For the samples below, the `AZURE_URL`, `AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, and `AZURE_CLIENT_SECRET` environment variables have to be set. -The client requires an instance of [TokenCredential](https://docs.microsoft.com/en-us/dotnet/api/azure.core.tokencredential?view=azure-dotnet) or [ServiceClientCredentials](https://docs.microsoft.com/en-us/dotnet/api/microsoft.rest.serviceclientcredentials?view=azure-dotnet). -In this samples, we illustrate how to use one derived class: [DefaultAzureCredentials](https://docs.microsoft.com/en-us/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet). +The client requires an instance of [TokenCredential](https://docs.microsoft.com/dotnet/api/azure.core.tokencredential?view=azure-dotnet) or [ServiceClientCredentials](https://docs.microsoft.com/dotnet/api/microsoft.rest.serviceclientcredentials?view=azure-dotnet). +In this samples, we illustrate how to use one derived class: [DefaultAzureCredentials](https://docs.microsoft.com/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet). > Note: In order to access the data plane for the Digital Twins service, the entity must be given permissions. > To do this, use the Azure CLI command: `az dt rbac assign-role --assignee '' --role owner -n ''` @@ -127,7 +127,7 @@ console.log(`DigitalTwin: ${twin.body}`); ### Query digital twins -Query the Azure Digital Twins instance for digital twins using the [Azure Digital Twins Query Store lanaguage](https://review.docs.microsoft.com/en-us/azure/digital-twins-v2/concepts-query-language?branch=pr-en-us-114648). Query calls support paging. Here's an example of how to query for digital twins and how to iterate over the results. +Query the Azure Digital Twins instance for digital twins using the [Azure Digital Twins Query Store lanaguage](https://review.docs.microsoft.com/azure/digital-twins-v2/concepts-query-language?branch=pr-en-us-114648). Query calls support paging. Here's an example of how to query for digital twins and how to iterate over the results. ```JavaScript Snippet:dt_digitaltwins_query const query = "SELECT * FROM digitaltwins"; diff --git a/sdk/eventgrid/eventgrid/README.md b/sdk/eventgrid/eventgrid/README.md index d6e5a0474a10..ab16a06fd6a3 100644 --- a/sdk/eventgrid/eventgrid/README.md +++ b/sdk/eventgrid/eventgrid/README.md @@ -1,6 +1,6 @@ # Azure Event Grid client library for JavaScript -[Azure Event Grid](https://azure.microsoft.com/en-us/services/event-grid/) is a cloud-based service that provides reliable event delivery at massive scale. +[Azure Event Grid](https://azure.microsoft.com/services/event-grid/) is a cloud-based service that provides reliable event delivery at massive scale. Use the client library to: @@ -11,7 +11,7 @@ Use the client library to: [Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventgrid/eventgrid/) | [Package (NPM)](https://www.npmjs.com/package/@azure/eventgrid) | [API reference documentation](https://aka.ms/azsdk-js-eventgrid-ref-docs) | -[Product documentation](https://docs.microsoft.com/en-us/azure/event-grid/) | +[Product documentation](https://docs.microsoft.com/azure/event-grid/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventgrid/eventgrid/samples) ## Getting started @@ -256,5 +256,5 @@ If you'd like to contribute to this library, please read the [contributing guide [azure_cli]: https://docs.microsoft.com/cli/azure [azure_sub]: https://azure.microsoft.com/free/ -[event_grid]: https://docs.microsoft.com/en-us/azure/event-grid +[event_grid]: https://docs.microsoft.com/azure/event-grid [azure_portal]: https://portal.azure.com diff --git a/sdk/eventgrid/eventgrid/samples/javascript/README.md b/sdk/eventgrid/eventgrid/samples/javascript/README.md index 000c17665a53..8e61bc1f1e80 100644 --- a/sdk/eventgrid/eventgrid/samples/javascript/README.md +++ b/sdk/eventgrid/eventgrid/samples/javascript/README.md @@ -50,5 +50,5 @@ Take a look at our [API Documentation][apiref] for more information about the AP [sendcloudevent]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventgrid/eventgrid/samples/javascript/src/sendCloudEvent.js [consumefromsb]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventgrid/eventgrid/samples/javascript/src/consumeEventsFromServiceBusQueue.js [apiref]: https://azure.github.io/azure-sdk-for-js/eventgrid.html -[azeventgrid]: https://azure.microsoft.com/en-us/services/event-grid/ +[azeventgrid]: https://azure.microsoft.com/services/event-grid/ [freesub]: https://azure.microsoft.com/free/ diff --git a/sdk/eventgrid/eventgrid/samples/typescript/README.md b/sdk/eventgrid/eventgrid/samples/typescript/README.md index b8257eb4922b..4546660dbf17 100644 --- a/sdk/eventgrid/eventgrid/samples/typescript/README.md +++ b/sdk/eventgrid/eventgrid/samples/typescript/README.md @@ -62,6 +62,6 @@ Take a look at our [API Documentation][apiref] for more information about the AP [sendcloudevent]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventgrid/eventgrid/samples/typescript/src/sendCloudEvent.ts [consumefromsb]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventgrid/eventgrid/samples/typescript/src/consumeEventsFromServiceBusQueue.ts [apiref]: https://azure.github.io/azure-sdk-for-js/eventgrid.html -[azeventgrid]: https://azure.microsoft.com/en-us/services/event-grid/ +[azeventgrid]: https://azure.microsoft.com/services/event-grid/ [freesub]: https://azure.microsoft.com/free/ [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/eventhub/README.md b/sdk/eventhub/README.md index 7823a640f3ad..fa753632fb70 100644 --- a/sdk/eventhub/README.md +++ b/sdk/eventhub/README.md @@ -1,8 +1,8 @@ # Azure Event Hubs for node.js We have two client libraries for Azure Event Hubs -- `@azure/event-hubs` - The Event Hubs client for sending and receiving messages. You can find more info over [here](./event-hubs). -- `@azure/event-processor-host` - The Event Processor Host for efficient receiving of messages. You can find more info over [here](./event-processor-host). +- `@azure/event-hubs` - The Event Hubs client for sending and receiving messages. You can find more info over [here](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/event-hubs). +- `@azure/event-processor-host` - The Event Processor Host for efficient receiving of messages. You can find more info over [here](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/event-processor-host). ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Feventhub%2FREADME.png) diff --git a/sdk/eventhub/event-hubs/CHANGELOG.md b/sdk/eventhub/event-hubs/CHANGELOG.md index 973320b6d283..ba211fd1e195 100644 --- a/sdk/eventhub/event-hubs/CHANGELOG.md +++ b/sdk/eventhub/event-hubs/CHANGELOG.md @@ -169,7 +169,7 @@ Construction of both objects is the same as it was for the previous client. ### Breaking changes - Removed the `createFromIotHubConnectionString` method from `EventHubClient`. ([PR #5311](https://github.com/Azure/azure-sdk-for-js/pull/5311)). - Instead, pass an [Event Hubs-compatible connection string](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin) + Instead, pass an [Event Hubs-compatible connection string](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin) when instantiating an `EventHubClient` to read properties or events from an IoT Hub. Previously: diff --git a/sdk/eventhub/event-hubs/README.md b/sdk/eventhub/event-hubs/README.md index 21d10c1eea3e..a515a1b3f7ff 100644 --- a/sdk/eventhub/event-hubs/README.md +++ b/sdk/eventhub/event-hubs/README.md @@ -1,13 +1,13 @@ # Azure Event Hubs client library for Javascript -Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers. This lets you process and analyze the massive amounts of data produced by your connected devices and applications. If you would like to know more about Azure Event Hubs, you may wish to review: [What is Event Hubs](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about)? +Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them to multiple consumers. This lets you process and analyze the massive amounts of data produced by your connected devices and applications. If you would like to know more about Azure Event Hubs, you may wish to review: [What is Event Hubs](https://docs.microsoft.com/azure/event-hubs/event-hubs-about)? The Azure Event Hubs client library allows you to send and receive events in your Node.js application. [Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs) | [Package (npm)](https://www.npmjs.com/package/@azure/event-hubs) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/event-hubs) | -[Product documentation](https://azure.microsoft.com/en-us/services/event-hubs/) | +[Product documentation](https://azure.microsoft.com/services/event-hubs/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs/samples) **NOTE**: If you are using version 2.1.0 or lower and want to migrate to the latest version @@ -30,7 +30,7 @@ Install the Azure Event Hubs client library using npm ### Prerequisites You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Event Hubs Namespace](https://docs.microsoft.com/en-us/azure/event-hubs/) to use this package. +[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. #### Configure Typescript @@ -52,7 +52,7 @@ There are constructor overloads to support different ways of instantiating these #### Use connection string for the Event Hubs namespace -One of the constructor overloads takes a connection string of the form `Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;` and entity name to your Event Hub instance. You can create a consumer group and get the connection string as well as the entity name from the [Azure portal](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string#get-connection-string-from-the-portal). +One of the constructor overloads takes a connection string of the form `Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;` and entity name to your Event Hub instance. You can create a consumer group and get the connection string as well as the entity name from the [Azure portal](https://docs.microsoft.com/azure/event-hubs/event-hubs-get-connection-string#get-connection-string-from-the-portal). ```javascript const { EventHubProducerClient, EventHubConsumerClient } = require("@azure/event-hubs"); @@ -83,7 +83,7 @@ const consumerClient = new EventHubConsumerClient( #### Use the Event Hubs namespace and Azure Identity -This constructor overload takes the host name and entity name of your Event Hub instance and credential that implements the TokenCredential interface. This allows you to authenticate using an Azure Active Directory principal. There are implementations of the `TokenCredential` interface available in the [@azure/identity](https://www.npmjs.com/package/@azure/identity) package. The host name is of the format `.servicebus.windows.net`. When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs, please refer to [the associated documentation](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-azure-active-directory). +This constructor overload takes the host name and entity name of your Event Hub instance and credential that implements the TokenCredential interface. This allows you to authenticate using an Azure Active Directory principal. There are implementations of the `TokenCredential` interface available in the [@azure/identity](https://www.npmjs.com/package/@azure/identity) package. The host name is of the format `.servicebus.windows.net`. When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the Azure Event Hubs Data Owner role. For more information about using Azure Active Directory authorization with Event Hubs, please refer to [the associated documentation](https://docs.microsoft.com/azure/event-hubs/authorize-access-azure-active-directory). ```javascript const { EventHubProducerClient, EventHubConsumerClient } = require("@azure/event-hubs"); @@ -109,7 +109,7 @@ const consumerClient = new EventHubConsumerClient( - A **consumer group** is a view of an entire Event Hub. Consumer groups enable multiple consuming applications to each have a separate view of the event stream, and to read the stream independently at their own pace and from their own position. There can be at most 5 concurrent readers on a partition per consumer group; however it is recommended that there is only one active consumer for a given partition and consumer group pairing. Each active reader receives all of the events from its partition; If there are multiple readers on the same partition, then they will receive duplicate events. -For more concepts and deeper discussion, see: [Event Hubs Features](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features) +For more concepts and deeper discussion, see: [Event Hubs Features](https://docs.microsoft.com/azure/event-hubs/event-hubs-features) ### Guidance around retries @@ -361,7 +361,7 @@ async function main() { main(); ``` -Please see [Balance partition load across multiple instances of your application](https://docs.microsoft.com/en-us/azure/event-hubs/event-processor-balance-partition-load) +Please see [Balance partition load across multiple instances of your application](https://docs.microsoft.com/azure/event-hubs/event-processor-balance-partition-load) to learn more. #### Consume events from a single partition @@ -422,7 +422,7 @@ The associated connection string will not have send claims, hence sending events is not possible. - Please notice that the connection string needs to be for an - [Event Hub-compatible endpoint](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin) + [Event Hub-compatible endpoint](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin) (e.g. "Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name") ```javascript @@ -498,7 +498,7 @@ export DEBUG=azure:*:(error|warning),rhea-promise:error,rhea:events,rhea:frames, Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs/samples) directory for detailed examples of how to use this library to send and receive events to/from -[Event Hubs](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about). +[Event Hubs](https://docs.microsoft.com/azure/event-hubs/event-hubs-about). ## Contributing diff --git a/sdk/eventhub/event-hubs/migrationguide.md b/sdk/eventhub/event-hubs/migrationguide.md index 4813fef27c97..c0d0b8592f88 100644 --- a/sdk/eventhub/event-hubs/migrationguide.md +++ b/sdk/eventhub/event-hubs/migrationguide.md @@ -30,9 +30,9 @@ demonstrating this [here](https://github.com/Azure/azure-sdk-for-js/blob/master/ In V5 we've simplified the API surface, making two distinct clients, rather than having a single `EventHubClient`: -- [EventHubProducerClient](https://docs.microsoft.com/en-us/javascript/api/@azure/event-hubs/eventhubproducerclient) +- [EventHubProducerClient](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventhubproducerclient) for sending messages. -- [EventHubConsumerClient](https://docs.microsoft.com/en-us/javascript/api/@azure/event-hubs/eventhubconsumerclient) +- [EventHubConsumerClient](https://docs.microsoft.com/javascript/api/@azure/event-hubs/eventhubconsumerclient) for receiving messages. We've also merged the functionality from `EventProcessorHost` from the `@azure/event-processor-host` package into diff --git a/sdk/eventhub/event-hubs/samples/browserSample/README.md b/sdk/eventhub/event-hubs/samples/browserSample/README.md index 8791e4f2e177..419578959ea6 100644 --- a/sdk/eventhub/event-hubs/samples/browserSample/README.md +++ b/sdk/eventhub/event-hubs/samples/browserSample/README.md @@ -30,7 +30,7 @@ You can set the Event Hubs and authentication properties you'll need to run the Register a new application in AAD and assign the "Azure Event Hubs Data Owner" role to it. -- See https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app +- See https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app to register a new application in the Azure Active Directory. - Note down the client id and tenant id from the above step. You will need to set these in the [configuration.js][configuration] file. @@ -75,7 +75,7 @@ Take a look at our [API Documentation][apiref] for more information about the AP [htmlpage]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs/samples/browserSample/index.html [apiref]: https://docs.microsoft.com/javascript/api/@azure/event-hubs [azhubacct]: https://docs.microsoft.com/azure/event-hubs/event-hubs-node-get-started-send -[aziothub]: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-node-node-module-twin-getstarted +[aziothub]: https://docs.microsoft.com/azure/iot-hub/iot-hub-node-node-module-twin-getstarted [freesub]: https://azure.microsoft.com/free/ [browsercred]: https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/using-azure-identity.md#interactivebrowsercredential -[implicitgrantflow]: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-implicit-grant-flow +[implicitgrantflow]: https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-implicit-grant-flow diff --git a/sdk/eventhub/event-hubs/samples/javascript/README.md b/sdk/eventhub/event-hubs/samples/javascript/README.md index 0d8f56c77219..e5b58ea1404f 100644 --- a/sdk/eventhub/event-hubs/samples/javascript/README.md +++ b/sdk/eventhub/event-hubs/samples/javascript/README.md @@ -72,7 +72,7 @@ Take a look at our [API Documentation][apiref] for more information about the AP [apiref]: https://docs.microsoft.com/javascript/api/@azure/event-hubs [checkpointing]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/eventhubs-checkpointstore-blob/samples/javascript/receiveEventsUsingCheckpointStore.js [azhubacct]: https://docs.microsoft.com/azure/event-hubs/event-hubs-node-get-started-send -[aziothub]: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-node-node-module-twin-getstarted +[aziothub]: https://docs.microsoft.com/azure/iot-hub/iot-hub-node-node-module-twin-getstarted [freesub]: https://azure.microsoft.com/free/ [package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs/README.md [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/eventhub/event-hubs/samples/typescript/README.md b/sdk/eventhub/event-hubs/samples/typescript/README.md index cb51726bca24..f5ffd318e118 100644 --- a/sdk/eventhub/event-hubs/samples/typescript/README.md +++ b/sdk/eventhub/event-hubs/samples/typescript/README.md @@ -78,7 +78,7 @@ Take a look at our [API Documentation][apiref] for more information about the AP [apiref]: https://docs.microsoft.com/javascript/api/@azure/event-hubs [checkpointing]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/eventhubs-checkpointstore-blob/samples/typescript/src/receiveEventsUsingCheckpointStore.ts [azhubacct]: https://docs.microsoft.com/azure/event-hubs/event-hubs-node-get-started-send -[aziothub]: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-node-node-module-twin-getstarted +[aziothub]: https://docs.microsoft.com/azure/iot-hub/iot-hub-node-node-module-twin-getstarted [freesub]: https://azure.microsoft.com/free/ [package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs/README.md [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/eventhub/event-hubs/test/README.md b/sdk/eventhub/event-hubs/test/README.md index 158403f844d8..2744c0bfffe1 100644 --- a/sdk/eventhub/event-hubs/test/README.md +++ b/sdk/eventhub/event-hubs/test/README.md @@ -8,8 +8,8 @@ The Azure Event Hubs client does not have any recorded tests and so, all the tes The Azure resources that are used by the tests in this project are: -- An [Azure Event Hubs namespace](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features#namespace) with atleast one Event Hub instance in it. -- An [Azure Storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview) configured to provide [blob storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#blob-storage-resources). +- An [Azure Event Hubs namespace](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#namespace) with atleast one Event Hub instance in it. +- An [Azure Storage account](https://docs.microsoft.com/azure/storage/common/storage-account-overview) configured to provide [blob storage](https://docs.microsoft.com/azure/storage/blobs/storage-blobs-introduction#blob-storage-resources). - An Azure Active Directory application for the tests to use. See the [AAD based authentication](#AAD-based-authentication) for steps to register the application. To run the live tests, you will also need to set the below environment variables: @@ -26,7 +26,7 @@ The following steps will help you setup the AAD credentials. ### Register a new application in AAD -- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). +- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). - Note down the `CLIENT_ID` and `TENANT_ID`. - In the "Certificates & Secrets" tab, create a secret and note that down. @@ -35,6 +35,6 @@ The following steps will help you setup the AAD credentials. - In the Azure portal, go to your Azure Event Hubs namespace and assign the **Azure Event Hubs Data Owner** role to the registered application. - This can be done from `Role assignment` section of `Access control (IAM)` tab (in the left-side-navbar of your Azure Event Hubs namespace in the Azure portal) _Doing this would allow the registered application manage the resource, i.e., entity creation, deletion, etc._ -- For more information on securing your Azure Event Hubs namespace: [Learn more](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-event-hubs) +- For more information on securing your Azure Event Hubs namespace: [Learn more](https://docs.microsoft.com/azure/event-hubs/authorize-access-event-hubs) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Feventhub%2Fevent-hubs%2Ftest%2FREADME.png) diff --git a/sdk/eventhub/event-processor-host/README.md b/sdk/eventhub/event-processor-host/README.md index 0faa7d4548c0..f172d5a0d2e4 100644 --- a/sdk/eventhub/event-processor-host/README.md +++ b/sdk/eventhub/event-processor-host/README.md @@ -9,7 +9,7 @@ Azure Storage Blob. This makes it easy to continue receiving messages from where #### Conceptual Overview ![overview](https://raw.githubusercontent.com/Azure/azure-sdk-for-js/master/sdk/eventhub/event-processor-host/eph.png) -- More information about Azure Event Processor Host can be found over [here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-event-processor-host). +- More information about Azure Event Processor Host can be found over [here](https://docs.microsoft.com/azure/event-hubs/event-hubs-event-processor-host). - General overview of how the Event Processor Host SDK works internally can be found over [here](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/event-processor-host/overview.md). ## Pre-requisite ## diff --git a/sdk/eventhub/event-processor-host/samples/README.md b/sdk/eventhub/event-processor-host/samples/README.md index 1664b7122e23..70a806bd286b 100644 --- a/sdk/eventhub/event-processor-host/samples/README.md +++ b/sdk/eventhub/event-processor-host/samples/README.md @@ -12,13 +12,13 @@ npm install @azure/event-processor-host - In the [Azure Portal](https://portal.azure.com), go to **Dashboard > Event Hubs > _your-eventhubs-namespace_**. - If you don't have a Event Hubs resource, then Here are the docs which would help you create a EventHubs/Iothub resources in the portal: - - [Azure Event Hubs - NodeJS DOCS](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-node-get-started-send). - - [Azure IoT Hubs - NodeJS DOCS](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-node-node-module-twin-getstarted). + - [Azure Event Hubs - NodeJS DOCS](https://docs.microsoft.com/azure/event-hubs/event-hubs-node-get-started-send). + - [Azure IoT Hubs - NodeJS DOCS](https://docs.microsoft.com/azure/iot-hub/iot-hub-node-node-module-twin-getstarted). - Note down the "Primary Connection String" of **RootManageSharedAccessKey** at **Shared access policies** under **Settings** tab. - Find the "Event Hubs" tab right under "Entities" at **_your-eventhubs-namespace_**, create a Event Hub and note down its name. - > _Note : **RootManageSharedAccessKey** is automatically created for the namespace and has permissions for the entire namespace. If you want to use restricted access, refer [Shared Access Signatures](https://docs.microsoft.com/en-us/rest/api/eventhub/generate-sas-token), create the Access Keys exclusive to the specific Event Hubs._ + > _Note : **RootManageSharedAccessKey** is automatically created for the namespace and has permissions for the entire namespace. If you want to use restricted access, refer [Shared Access Signatures](https://docs.microsoft.com/rest/api/eventhub/generate-sas-token), create the Access Keys exclusive to the specific Event Hubs._ - You would also need an Azure Storage Account when working with Event Processor Host. The docs are at - [Create a storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal). After the storage account is created, find the connection string at **Access keys** tab in the **Settings** section. + [Create a storage account](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal). After the storage account is created, find the connection string at **Access keys** tab in the **Settings** section. Before running a sample, update it with the connection string and the hub name you have noted down above. diff --git a/sdk/eventhub/event-processor-host/test/README.md b/sdk/eventhub/event-processor-host/test/README.md index 0bae80185a90..6ec857edec6a 100644 --- a/sdk/eventhub/event-processor-host/test/README.md +++ b/sdk/eventhub/event-processor-host/test/README.md @@ -6,11 +6,11 @@ The Azure Event Processor Host client does not have any recorded tests and so, a The Azure resources that are used by the tests in this project are: -- An [Azure Event Hubs namespace](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features#namespace). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). +- An [Azure Event Hubs namespace](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#namespace). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). - Some very basic Network configurations for the Event Hubs namespace. -- A [consumer group](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features#consumer-groups) to publish and subscribe to the Event Hubs namespace created. -- An [Azure Storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview) configured to provide [blob storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#blob-storage-resources). -- An [Azure IoT Hub account](https://docs.microsoft.com/en-us/azure/iot-hub/about-iot-hub). +- A [consumer group](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#consumer-groups) to publish and subscribe to the Event Hubs namespace created. +- An [Azure Storage account](https://docs.microsoft.com/azure/storage/common/storage-account-overview) configured to provide [blob storage](https://docs.microsoft.com/azure/storage/blobs/storage-blobs-introduction#blob-storage-resources). +- An [Azure IoT Hub account](https://docs.microsoft.com/azure/iot-hub/about-iot-hub). To run the live tests, you will also need to set the below environment variables: @@ -27,7 +27,7 @@ The following steps will help you setup the AAD credentials. ### Register a new application in AAD -- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). +- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). - Note down the `CLIENT_ID` and `TENANT_ID`. - In the "Certificates & Secrets" tab, create a secret and note that down. @@ -36,6 +36,6 @@ The following steps will help you setup the AAD credentials. - In the Azure portal, go to your Azure Event Hubs namespace and assign the **Owner** role to the registered application. - This can be done from `Role assignment` section of `Access control (IAM)` tab (in the left-side-navbar of your Azure Event Hubs namespace in the Azure portal)
_Doing this would allow the registered application manage the namespace, i.e., entity creation, deletion, etc.,_
-- For more information on securing your Azure Event Hubs namespace: [Learn more](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-event-hubs) +- For more information on securing your Azure Event Hubs namespace: [Learn more](https://docs.microsoft.com/azure/event-hubs/authorize-access-event-hubs) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Feventhub%2Fevent-processor-host%2Ftest%2FREADME.png) diff --git a/sdk/eventhub/eventhubs-checkpointstore-blob/README.md b/sdk/eventhub/eventhubs-checkpointstore-blob/README.md index c0b0b6f65240..295e459924ca 100644 --- a/sdk/eventhub/eventhubs-checkpointstore-blob/README.md +++ b/sdk/eventhub/eventhubs-checkpointstore-blob/README.md @@ -2,7 +2,7 @@ An Azure Blob storage based solution to store checkpoints and to aid in load balancing when using `EventHubConsumerClient` from the [@azure/event-hubs](https://www.npmjs.com/package/@azure/event-hubs) library -[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/eventhubs-checkpointstore-blob) | [Package (npm)](https://www.npmjs.com/package/@azure/eventhubs-checkpointstore-blob) | [API Reference Documentation](https://docs.microsoft.com/en-us/javascript/api/@azure/eventhubs-checkpointstore-blob/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/eventhubs-checkpointstore-blob/samples) +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/eventhubs-checkpointstore-blob) | [Package (npm)](https://www.npmjs.com/package/@azure/eventhubs-checkpointstore-blob) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/eventhubs-checkpointstore-blob/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/eventhubs-checkpointstore-blob/samples) ## Getting started @@ -13,7 +13,7 @@ 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/en-us/azure/event-hubs/) to use this package, and a [Storage account](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction) +[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. @@ -45,7 +45,7 @@ You also need to enable `compilerOptions.allowSyntheticDefaultImports` in your t and to provide resiliency if a failover between readers running on different machines occurs. It is possible to return to older data by specifying a lower offset from this checkpointing process. Through this mechanism, checkpointing enables both failover resiliency and event stream replay. - A [BlobCheckpointStore](https://docs.microsoft.com/en-us/javascript/api/@azure/eventhubs-checkpointstore-blob/blobcheckpointstore) + A [BlobCheckpointStore](https://docs.microsoft.com/javascript/api/@azure/eventhubs-checkpointstore-blob/blobcheckpointstore) is a class that implements key methods required by the EventHubConsumerClient to balance load and update checkpoints. ## Examples @@ -73,10 +73,10 @@ const checkpointStore = new BlobCheckpointStore(containerClient); ### Checkpoint events using Azure Blob storage To checkpoint events received using Azure Blob Storage, you will need to pass an object -that is compatible with the [SubscriptionEventHandlers](https://docs.microsoft.com/en-us/javascript/api/@azure/event-hubs/subscriptioneventhandlers) +that is compatible with the [SubscriptionEventHandlers](https://docs.microsoft.com/javascript/api/@azure/event-hubs/subscriptioneventhandlers) interface along with code to call the `updateCheckpoint()` method. -In this example, `SubscriptionHandlers` implements [SubscriptionEventHandlers](https://docs.microsoft.com/en-us/javascript/api/@azure/event-hubs/subscriptioneventhandlers) and also handles checkpointing. +In this example, `SubscriptionHandlers` implements [SubscriptionEventHandlers](https://docs.microsoft.com/javascript/api/@azure/event-hubs/subscriptioneventhandlers) and also handles checkpointing. ```javascript const { EventHubConsumerClient } = require("@azure/event-hubs"); diff --git a/sdk/eventhub/eventhubs-checkpointstore-blob/test/README.md b/sdk/eventhub/eventhubs-checkpointstore-blob/test/README.md index d99047f72886..c7f922890d36 100644 --- a/sdk/eventhub/eventhubs-checkpointstore-blob/test/README.md +++ b/sdk/eventhub/eventhubs-checkpointstore-blob/test/README.md @@ -6,11 +6,11 @@ The Azure Event Hubs Checkpoint Store client does not have any recorded tests an The Azure resources that are used by the tests in this project are: -- An [Azure Event Hubs namespace](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features#namespace). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). +- An [Azure Event Hubs namespace](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#namespace). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). - Some very basic Network configurations for the Event Hubs namespace. -- A [consumer group](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-features#consumer-groups) to publish and subscribe to the Event Hubs namespace created. -- An [Azure Storage account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview) configured to provide [blob storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#blob-storage-resources). -- An [Azure IoT Hub account](https://docs.microsoft.com/en-us/azure/iot-hub/about-iot-hub). +- A [consumer group](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#consumer-groups) to publish and subscribe to the Event Hubs namespace created. +- An [Azure Storage account](https://docs.microsoft.com/azure/storage/common/storage-account-overview) configured to provide [blob storage](https://docs.microsoft.com/azure/storage/blobs/storage-blobs-introduction#blob-storage-resources). +- An [Azure IoT Hub account](https://docs.microsoft.com/azure/iot-hub/about-iot-hub). To run the live tests, you will also need to set the below environment variables: @@ -27,7 +27,7 @@ The following steps will help you setup the AAD credentials. ### Register a new application in AAD -- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). +- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). - Note down the `CLIENT_ID` and `TENANT_ID`. - In the "Certificates & Secrets" tab, create a secret and note that down. @@ -36,6 +36,6 @@ The following steps will help you setup the AAD credentials. - In the Azure portal, go to your Azure Event Hubs namespace and assign the **Owner** role to the registered application. - This can be done from `Role assignment` section of `Access control (IAM)` tab (in the left-side-navbar of your Azure Event Hubs namespace in the Azure portal)
_Doing this would allow the registered application manage the namespace, i.e., entity creation, deletion, etc.,_
-- For more information on securing your Azure Event Hubs namespace: [Learn more](https://docs.microsoft.com/en-us/azure/event-hubs/authorize-access-event-hubs) +- For more information on securing your Azure Event Hubs namespace: [Learn more](https://docs.microsoft.com/azure/event-hubs/authorize-access-event-hubs) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Feventhub%2Fevent-processor-host%2Ftest%2FREADME.png) diff --git a/sdk/identity/identity/CHANGELOG.md b/sdk/identity/identity/CHANGELOG.md index 151f450f7c3e..66b0b679eff9 100644 --- a/sdk/identity/identity/CHANGELOG.md +++ b/sdk/identity/identity/CHANGELOG.md @@ -87,7 +87,7 @@ ## 1.0.0-preview.4 (2019-10-07) -- 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)) +- Introduced the `AuthorizationCodeCredential` for performing the [authorization code flow](https://docs.microsoft.com/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)) diff --git a/sdk/identity/identity/README.md b/sdk/identity/identity/README.md index 6badbe20ffa0..3af74dfc0e61 100644 --- a/sdk/identity/identity/README.md +++ b/sdk/identity/identity/README.md @@ -2,7 +2,7 @@ This library simplifies authentication against Azure Active Directory for Azure SDK libraries. It provides a set of `TokenCredential` implementations which can be passed into SDK libraries -to authenticate API requests. It supports token authentication using an Azure Active Directory [service principal](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) or [managed identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview). +to authenticate API requests. It supports token authentication using an Azure Active Directory [service principal](https://docs.microsoft.com/cli/azure/create-an-azure-service-principal-azure-cli) or [managed identity](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview). ## Getting started diff --git a/sdk/identity/identity/test/manual-integration/Kubernetes/INSTRUCTIONS.md b/sdk/identity/identity/test/manual-integration/Kubernetes/INSTRUCTIONS.md index 4ae75a155e2f..30050b8d2fd4 100644 --- a/sdk/identity/identity/test/manual-integration/Kubernetes/INSTRUCTIONS.md +++ b/sdk/identity/identity/test/manual-integration/Kubernetes/INSTRUCTIONS.md @@ -2,7 +2,7 @@ # prerequisite tools - Azure CLI - - https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest + - https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest - Docker CLI - https://hub.docker.com/search?q=&type=edition&offering=community - Helm 2.x (3.x doesn't handle CRDs properly at time of writing) @@ -164,4 +164,4 @@ az keyvault secret show -n "secret-name-pod" --vault-name "$($KEY_VAULT_NAME)" ### delete Azure resources ```sh az group delete -n $RESOURCE_GROUP -y --no-wait -``` \ No newline at end of file +``` diff --git a/sdk/keyvault/README.md b/sdk/keyvault/README.md index cbb375259665..c533b9bb894f 100644 --- a/sdk/keyvault/README.md +++ b/sdk/keyvault/README.md @@ -4,9 +4,9 @@ Azure Key Vault is a Microsoft-managed service providing cloud keys, secrets, an This project provides client libraries in JavaScript that makes it easy to consume Microsoft Azure Key Vault service. -- [Source Code - Keys](./keyvault-keys) -- [Source Code - Secrets](./keyvault-secrets) -- [Source Code - Certificates](./keyvault-certificates) +- [Source Code - Keys](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys) +- [Source Code - Secrets](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets) +- [Source Code - Certificates](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates) - [Product documentation](https://docs.microsoft.com/azure/key-vault) - @azure/keyvault-keys [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-keys) - @azure/keyvault-secrets [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-secrets) @@ -56,7 +56,7 @@ This library depends on following ES features which need external polyfills load - `String.prototype.includes` - `Array.prototype.includes` - `Object.assign` -- `Object.keys` (Override IE11's `Object.keys` with ES6 polyfill to enable [ES6 behavior](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys#Notes)) +- `Object.keys` (Override IE11's `Object.keys` with ES6 polyfill to enable [ES6 behavior](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/keys#Notes)) - `Symbol` ## Getting Started @@ -85,15 +85,15 @@ const KeyVaultSecrets = require("@azure/keyvault-secrets"); ## Code Samples -- [KeyVault Keys Samples (JavaScript)](./keyvault-keys/samples/javascript) -- [KeyVault Keys Samples (TypeScript)](./keyvault-keys/samples/typescript) -- [KeyVault Keys Test Cases](./keyvault-keys/test/) -- [KeyVault Secrets Samples (JavaScript)](./keyvault-secrets/samples/javascript) -- [KeyVault Secrets Samples (TypeScript)](./keyvault-secrets/samples/typescript) -- [KeyVault Secrets Test Cases](./keyvault-secrets/test/) -- [KeyVault Certificates Samples (JavaScript)](./keyvault-certificates/samples/javascript) -- [KeyVault Certificates Samples (TypeScript)](./keyvault-certificates/samples/typescript) -- [KeyVault Certificates Test Cases](./keyvault-certificates/test/) +- [KeyVault Keys Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/javascript) +- [KeyVault Keys Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/typescript) +- [KeyVault Keys Test Cases](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/test/) +- [KeyVault Secrets Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/javascript) +- [KeyVault Secrets Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/typescript) +- [KeyVault Secrets Test Cases](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/test/) +- [KeyVault Certificates Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript) +- [KeyVault Certificates Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript) +- [KeyVault Certificates Test Cases](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/test/) ## Contributing diff --git a/sdk/keyvault/keyvault-admin/README.md b/sdk/keyvault/keyvault-admin/README.md index b34994538df5..0a7831563250 100644 --- a/sdk/keyvault/keyvault-admin/README.md +++ b/sdk/keyvault/keyvault-admin/README.md @@ -165,22 +165,22 @@ The methods that begin long running operations return a poller that allows you t We have samples both in JavaScript and TypeScript that show the access control and backup/restore features in this package. Please follow the corresponding readmes for detailed steps to run the samples. -- [Readme for JavaScript samples](./samples/javascript/README.md) -- [Readme for TypeScript samples](./samples/typescript/README.md) +- [Readme for JavaScript samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/README.md) +- [Readme for TypeScript samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/typescript/README.md) Direct links to the specific JavaScript samples follow: - Access control (RBAC): - - [Listing All Role Definitions](./samples/javascript/accessControlHelloWorld.js) - - [Listing All Role Assignments](./samples/javascript/accessControlHelloWorld.js) - - [Creating a Role Assignment](./samples/javascript/accessControlHelloWorld.js) - - [Getting a Role Assignment](./samples/javascript/accessControlHelloWorld.js) - - [Deleting a Role Assignment](./samples/javascript/accessControlHelloWorld.js) + - [Listing All Role Definitions](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/accessControlHelloWorld.js) + - [Listing All Role Assignments](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/accessControlHelloWorld.js) + - [Creating a Role Assignment](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/accessControlHelloWorld.js) + - [Getting a Role Assignment](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/accessControlHelloWorld.js) + - [Deleting a Role Assignment](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/accessControlHelloWorld.js) - Backup and restore: - - [Performing a full key backup](./samples/javascript/backupRestoreHelloWorld.js) - - [Performing a full key restore](./samples/javascript/backupRestoreHelloWorld.js) - - [Performing a selective key backup](./samples/javascript/backupSelectiveRestore.js) - - [Performing a selective key restore](./samples/javascript/backupSelectiveRestore.js) + - [Performing a full key backup](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/backupRestoreHelloWorld.js) + - [Performing a full key restore](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/backupRestoreHelloWorld.js) + - [Performing a selective key backup](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/backupSelectiveRestore.js) + - [Performing a selective key restore](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/samples/javascript/backupSelectiveRestore.js) ## Troubleshooting diff --git a/sdk/keyvault/keyvault-certificates/README.md b/sdk/keyvault/keyvault-certificates/README.md index 50abbe389678..07592af8456b 100644 --- a/sdk/keyvault/keyvault-certificates/README.md +++ b/sdk/keyvault/keyvault-certificates/README.md @@ -1,7 +1,7 @@ # Azure Key Vault Certificates client library for JavaScript Azure Key Vault is a service that allows you to encrypt authentication keys, storage account keys, data encryption keys, .pfx files, and passwords by using secured keys. -If you would like to know more about Azure Key Vault, you may want to review: [What is Azure Key Vault?](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-overview) +If you would like to know more about Azure Key Vault, you may want to review: [What is Azure Key Vault?](https://docs.microsoft.com/azure/key-vault/key-vault-overview) Azure Key Vault Certificates allows you to securely manage, store and tightly control your certificates. @@ -18,12 +18,12 @@ Use the client library for Azure Key Vault Certificates in your Node.js applicat > Note: This package cannot be used in the browser due to Azure Key Vault service limitations. -[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-certificates) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-certificates) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-certificates) | [Product documentation](https://azure.microsoft.com/en-us/services/key-vault/) | [Samples](./samples) +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-certificates) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-certificates) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-certificates) | [Product documentation](https://azure.microsoft.com/services/key-vault/) | [Samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples) ## Getting started **Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Key Vault resource](https://docs.microsoft.com/en-us/azure/key-vault/quick-create-portal) to use this package. +[Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal) to use this package. If you are using this package in a Node.js application, then use Node.js 8.x or higher. @@ -133,7 +133,7 @@ const client = new CertificateClient(url, credential); query. - **Soft delete** allows Key Vaults to support deletion and purging as two separate steps, so deleted certificates are not immediately lost. This only happens if the Key Vault - has [soft-delete](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) + has [soft-delete](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) enabled. - A **Certificate backup** can be generated from any created certificate. These backups come as binary data, and can only be used to regenerate a previously deleted certificate. @@ -534,7 +534,7 @@ main(); The `beginDeleteCertificate` method sets a certificate up for deletion. This process will happen in the background as soon as the necessary resources are available. -If [soft-delete](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) +If [soft-delete](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) is enabled for the Key Vault, this operation will only label the certificate as a _deleted_ certificate. A deleted certificate can't be updated. They can only be either read, recovered or purged. @@ -676,9 +676,9 @@ setLogLevel("info"); You can find more code samples through the following links: -- [KeyVault Certificates Samples (JavaScript)](./samples/javascript) -- [KeyVault Certificates Samples (TypeScript)](./samples/typescript) -- [KeyVault Certificates Test Cases](./test/) +- [KeyVault Certificates Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript) +- [KeyVault Certificates Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript) +- [KeyVault Certificates Test Cases](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/test/) ## Contributing diff --git a/sdk/keyvault/keyvault-certificates/samples/javascript/README.md b/sdk/keyvault/keyvault-certificates/samples/javascript/README.md index 7c8882144a4b..211181dc0705 100644 --- a/sdk/keyvault/keyvault-certificates/samples/javascript/README.md +++ b/sdk/keyvault/keyvault-certificates/samples/javascript/README.md @@ -16,7 +16,7 @@ These sample programs show how to use the JavaScript client libraries for Azure | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [backupAndRestore.js][backupandrestore] | creates a self-signed certificate, then makes a backup from it, then deletes it and purges it, and finally restores it | | [contacts.js][contacts] | creates, updates and deletes certificate contacts | -| [deleteAndRecover.js][deleteandrecover] | creates a self-signed certificate, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) | +| [deleteAndRecover.js][deleteandrecover] | creates a self-signed certificate, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) | | [helloWorld.js][helloworld] | creates a self-signed certificate, reads it in various ways, updates the tags of the certificate and finally deletes the certificate | | [issuers.js][issuers] | creates, updates and deletes certificate issuers | | [listCertificates.js][listcertificates] | lists previously created certificates in a single chunk and by page, then changes one of them and lists all the versions of that certificate, then deletes them and lists the deleted certificates. | diff --git a/sdk/keyvault/keyvault-certificates/samples/typescript/README.md b/sdk/keyvault/keyvault-certificates/samples/typescript/README.md index a2ef6a78ac7f..e272b94a6b68 100644 --- a/sdk/keyvault/keyvault-certificates/samples/typescript/README.md +++ b/sdk/keyvault/keyvault-certificates/samples/typescript/README.md @@ -16,7 +16,7 @@ These sample programs show how to use the TypeScript client libraries for Azure | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [backupAndRestore.ts][backupandrestore] | creates a self-signed certificate, then makes a backup from it, then deletes it and purges it, and finally restores it | | [contacts.ts][contacts] | creates, updates and deletes certificate contacts | -| [deleteAndRecover.ts][deleteandrecover] | creates a self-signed certificate, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) | +| [deleteAndRecover.ts][deleteandrecover] | creates a self-signed certificate, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) | | [helloWorld.ts][helloworld] | creates a self-signed certificate, reads it in various ways, updates the tags of the certificate and finally deletes the certificate | | [issuers.ts][issuers] | creates, updates and deletes certificate issuers | | [listCertificates.ts][listcertificates] | lists previously created certificates in a single chunk and by page, then changes one of them and lists all the versions of that certificate, then deletes them and lists the deleted certificates. | diff --git a/sdk/keyvault/keyvault-certificates/test/README.md b/sdk/keyvault/keyvault-certificates/test/README.md index c5c97cd1952d..8552563be346 100644 --- a/sdk/keyvault/keyvault-certificates/test/README.md +++ b/sdk/keyvault/keyvault-certificates/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resource that is used by the tests in this project is: -- An [Azure Key Vault](https://docs.microsoft.com/en-us/azure/key-vault/general/basic-concepts). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). +- An [Azure Key Vault](https://docs.microsoft.com/azure/key-vault/general/basic-concepts). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). To run the live tests, you will also need to set the below environment variables: @@ -16,7 +16,7 @@ To run the live tests, you will also need to set the below environment variables - `AZURE_TENANT_ID`: The Tenant ID of your organization in Azure Active Directory. - `KEYVAULT_NAME`: The name of the KeyVault to use. -The live tests in this project will create, modify and delete [certificates](https://docs.microsoft.com/en-us/azure/key-vault/certificates/about-certificates) inside of the provided Azure Key Vault. +The live tests in this project will create, modify and delete [certificates](https://docs.microsoft.com/azure/key-vault/certificates/about-certificates) inside of the provided Azure Key Vault. ## AAD based authentication @@ -24,7 +24,7 @@ The following steps will help you setup the AAD credentials. ### Register a new application in AAD -- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). +- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). - Note down the `CLIENT_ID` and `TENANT_ID`. - In the "Certificates & Secrets" tab, create a secret and note that down. @@ -33,6 +33,6 @@ The following steps will help you setup the AAD credentials. - In the Azure portal, go to your Azure Key Vault and assign the **Owner** role to the registered application. - This can be done from `Role assignment` section of `Access control (IAM)` tab (in the left-side-navbar of your Azure Key Vault in the Azure portal)
_Doing this would allow the registered application manage the resource, i.e., entity creation, deletion, etc.,_
-- For more information on securing your Key Vault: [Learn more](https://docs.microsoft.com/en-us/azure/key-vault/general/secure-your-key-vault) +- For more information on securing your Key Vault: [Learn more](https://docs.microsoft.com/azure/key-vault/general/secure-your-key-vault) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fkeyvault%2Fkeyvault-certificates%2Ftest%2FREADME.png) diff --git a/sdk/keyvault/keyvault-keys/README.md b/sdk/keyvault/keyvault-keys/README.md index 70a32afe7f4e..56e5951ae420 100644 --- a/sdk/keyvault/keyvault-keys/README.md +++ b/sdk/keyvault/keyvault-keys/README.md @@ -1,7 +1,7 @@ # Azure Key Vault Key client library for JavaScript Azure Key Vault is a service that allows you to encrypt authentication keys, storage account keys, data encryption keys, .pfx files, and passwords by using secured keys. -If you would like to know more about Azure Key Vault, you may want to review: [What is Azure Key Vault?](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-overview) +If you would like to know more about Azure Key Vault, you may want to review: [What is Azure Key Vault?](https://docs.microsoft.com/azure/key-vault/key-vault-overview) Azure Key Vault Key management allows you to create and control encryption keys that encrypt your data. @@ -25,12 +25,12 @@ Using the cryptography client available in this library you also have access to: > Note: This package cannot be used in the browser due to Azure Key Vault service limitations. -[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-keys) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-keys) | [Product documentation](https://azure.microsoft.com/en-us/services/key-vault/) | [Samples](./samples) +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-keys) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-keys) | [Product documentation](https://azure.microsoft.com/services/key-vault/) | [Samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples) ## Getting started **Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Key Vault resource](https://docs.microsoft.com/en-us/azure/key-vault/quick-create-portal) to use this package. +[Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal) to use this package. If you are using this package in a Node.js application, then use Node.js 8.x or higher. @@ -109,7 +109,7 @@ Use the [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to creat query. - **Soft delete** allows Key Vaults to support deletion and purging as two separate steps, so deleted keys are not immediately lost. This only happens if the Key Vault - has [soft-delete](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) + has [soft-delete](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) enabled. - A **Key backup** can be generated from any created key. These backups come as binary data, and can only be used to regenerate a previously deleted key. @@ -338,7 +338,7 @@ async function main() { main(); ``` -If [soft-delete](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) +If [soft-delete](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) is enabled for the Key Vault, this operation will only label the key as a _deleted_ key. A deleted key can't be updated. They can only be either read, recovered or purged. @@ -807,9 +807,9 @@ setLogLevel("info"); You can find more code samples through the following links: -- [KeyVault Keys Samples (JavaScript)](./samples/javascript) -- [KeyVault Keys Samples (TypeScript)](./samples/typescript) -- [KeyVault Keys Test Cases](./test/) +- [KeyVault Keys Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/javascript) +- [KeyVault Keys Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/typescript) +- [KeyVault Keys Test Cases](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/test/) ## Contributing diff --git a/sdk/keyvault/keyvault-keys/test/README.md b/sdk/keyvault/keyvault-keys/test/README.md index 600a1e24bb54..62e97dbf0eb1 100644 --- a/sdk/keyvault/keyvault-keys/test/README.md +++ b/sdk/keyvault/keyvault-keys/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resource that is used by the tests in this project is: -- An [Azure Key Vault](https://docs.microsoft.com/en-us/azure/key-vault/general/basic-concepts). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). +- An [Azure Key Vault](https://docs.microsoft.com/azure/key-vault/general/basic-concepts). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). To run the live tests, you will also need to set the below environment variables: @@ -16,7 +16,7 @@ To run the live tests, you will also need to set the below environment variables - `AZURE_TENANT_ID`: The Tenant ID of your organization in Azure Active Directory. - `KEYVAULT_NAME`: The name of the KeyVault to use. -The live tests in this project will create, modify and delete [keys](https://docs.microsoft.com/en-us/azure/key-vault/keys/about-keys) inside of the provided Azure Key Vault. +The live tests in this project will create, modify and delete [keys](https://docs.microsoft.com/azure/key-vault/keys/about-keys) inside of the provided Azure Key Vault. ## AAD based authentication @@ -24,7 +24,7 @@ The following steps will help you setup the AAD credentials. ### Register a new application in AAD -- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). +- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). - Note down the `CLIENT_ID` and `TENANT_ID`. - In the "Certificates & Secrets" tab, create a secret and note that down. @@ -33,6 +33,6 @@ The following steps will help you setup the AAD credentials. - In the Azure portal, go to your Azure Key Vault and assign the **Owner** role to the registered application. - This can be done from `Role assignment` section of `Access control (IAM)` tab (in the left-side-navbar of your Azure Key Vault in the Azure portal)
_Doing this would allow the registered application manage the resource, i.e., entity creation, deletion, etc.,_
-- For more information on securing your Key Vault: [Learn more](https://docs.microsoft.com/en-us/azure/key-vault/general/secure-your-key-vault) +- For more information on securing your Key Vault: [Learn more](https://docs.microsoft.com/azure/key-vault/general/secure-your-key-vault) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fkeyvault%2Fkeyvault-keys%2Ftest%2FREADME.png) diff --git a/sdk/keyvault/keyvault-secrets/README.md b/sdk/keyvault/keyvault-secrets/README.md index 1007ac05cf35..d328e465d030 100644 --- a/sdk/keyvault/keyvault-secrets/README.md +++ b/sdk/keyvault/keyvault-secrets/README.md @@ -1,7 +1,7 @@ # Azure Key Vault Secret client library for JavaScript Azure Key Vault is a service that allows you to encrypt authentication keys, storage account keys, data encryption keys, .pfx files, and passwords by using secured keys. -If you would like to know more about Azure Key Vault, you may want to review: [What is Azure Key Vault?](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-overview) +If you would like to know more about Azure Key Vault, you may want to review: [What is Azure Key Vault?](https://docs.microsoft.com/azure/key-vault/key-vault-overview) Azure Key Vault Secrets management allows you to securely store and tightly control access to tokens, passwords, certificates, API keys, @@ -19,12 +19,12 @@ Use the client library for Azure Key Vault Secrets in your Node.js application t > Note: This package cannot be used in the browser due to Azure Key Vault service limitations. -[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-secrets) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-secrets) | [Product documentation](https://azure.microsoft.com/en-us/services/key-vault/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets/samples) +[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets) | [Package (npm)](https://www.npmjs.com/package/@azure/keyvault-secrets) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/keyvault-secrets) | [Product documentation](https://azure.microsoft.com/services/key-vault/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets/samples) ## Getting started **Prerequisites**: You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Key Vault resource](https://docs.microsoft.com/en-us/azure/key-vault/quick-create-portal) to use this package. +[Key Vault resource](https://docs.microsoft.com/azure/key-vault/quick-create-portal) to use this package. If you are using this package in a Node.js application, then use Node.js 8.x or higher. @@ -103,7 +103,7 @@ Use the [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to creat query. - **Soft delete** allows Key Vaults to support deletion and purging as two separate steps, so deleted secrets are not immediately lost. This only happens if the Key Vault - has [soft-delete](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) + has [soft-delete](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) enabled. - A **Secret backup** can be generated from any created secret. These backups come as binary data, and can only be used to regenerate a previously deleted secret. @@ -314,7 +314,7 @@ async function main() { main(); ``` -If [soft-delete](https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) +If [soft-delete](https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) is enabled for the Key Vault, this operation will only label the secret as a _deleted_ secret. A deleted secret can't be updated. They can only be either read, recovered or purged. @@ -518,9 +518,9 @@ setLogLevel("info"); You can find more code samples through the following links: -- [KeyVault Secrets Samples (JavaScript)](./samples/javascript) -- [KeyVault Secrets Samples (TypeScript)](./samples/typescript) -- [KeyVault Secrets Test Cases](./test/) +- [KeyVault Secrets Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/javascript) +- [KeyVault Secrets Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/typescript) +- [KeyVault Secrets Test Cases](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/test/) ## Contributing diff --git a/sdk/keyvault/keyvault-secrets/samples/javascript/README.md b/sdk/keyvault/keyvault-secrets/samples/javascript/README.md index 34221c4aebba..1cc0ef1adca3 100644 --- a/sdk/keyvault/keyvault-secrets/samples/javascript/README.md +++ b/sdk/keyvault/keyvault-secrets/samples/javascript/README.md @@ -15,7 +15,7 @@ These sample programs show how to use the JavaScript client libraries for Azure | **File Name** | **Description** | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [backupAndRestore.js][backupandrestore] | creates a secret, then makes a backup from it, then deletes it and purges it, and finally restores it | -| [deleteAndRecover.js][deleteandrecover] | creates a secret, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) | +| [deleteAndRecover.js][deleteandrecover] | creates a secret, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) | | [helloWorld.js][helloworld] | creates, reads, updates, and deletes a secret | | [listOperations.js][listoperations] | creates a secret and shows various ways to iterate over the secret and its versions | | [purgeAllSecrets.js][purgeallsecrets] | purges all the secrets of a Key Vault (useful for repeated tests) | diff --git a/sdk/keyvault/keyvault-secrets/samples/typescript/README.md b/sdk/keyvault/keyvault-secrets/samples/typescript/README.md index f9b5952e7f95..f2d6e3e43701 100644 --- a/sdk/keyvault/keyvault-secrets/samples/typescript/README.md +++ b/sdk/keyvault/keyvault-secrets/samples/typescript/README.md @@ -15,7 +15,7 @@ These sample programs show how to use the TypeScript client libraries for Azure | **File Name** | **Description** | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [backupAndRestore.ts][backupandrestore] | creates a secret, then makes a backup from it, then deletes it and purges it, and finally restores it | -| [deleteAndRecover.ts][deleteandrecover] | creates a secret, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete) | +| [deleteAndRecover.ts][deleteandrecover] | creates a secret, then deletes it, then recovers it (soft-delete is required for this sample to run, see: https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete) | | [helloWorld.ts][helloworld] | creates, reads, updates, and deletes a secret | | [listOperations.ts][listoperations] | creates a secret and shows various ways to iterate over the secret and its versions | | [purgeAllSecrets.ts][purgeAllSecrets] | purges all the secrets of a Key Vault (useful for repeated tests) | diff --git a/sdk/keyvault/keyvault-secrets/test/README.md b/sdk/keyvault/keyvault-secrets/test/README.md index 2ece5de75bc3..8bd82f15d075 100644 --- a/sdk/keyvault/keyvault-secrets/test/README.md +++ b/sdk/keyvault/keyvault-secrets/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resource that is used by the tests in this project is: -- An [Azure Key Vault](https://docs.microsoft.com/en-us/azure/key-vault/general/basic-concepts). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). +- An [Azure Key Vault](https://docs.microsoft.com/azure/key-vault/general/basic-concepts). Your Azure application needs to be assigned as the **owner** of this Azure Key Vault. The steps are provided [below](#AAD-based-authentication). To run the live tests, you will also need to set the below environment variables: @@ -16,7 +16,7 @@ To run the live tests, you will also need to set the below environment variables - `AZURE_TENANT_ID`: The Tenant ID of your organization in Azure Active Directory. - `KEYVAULT_NAME`: The name of the KeyVault to use. -The live tests in this project will create, modify and delete [secrets](https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets) inside of the provided Azure Key Vault. +The live tests in this project will create, modify and delete [secrets](https://docs.microsoft.com/azure/key-vault/secrets/about-secrets) inside of the provided Azure Key Vault. ## AAD based authentication @@ -24,7 +24,7 @@ The following steps will help you setup the AAD credentials. ### Register a new application in AAD -- Follow [Documentation to register a new application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). +- Follow [Documentation to register a new application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) in the Azure Active Directory (in the Azure portal). - Note down the `CLIENT_ID` and `TENANT_ID`. - In the "Certificates & Secrets" tab, create a secret and note that down. @@ -33,6 +33,6 @@ The following steps will help you setup the AAD credentials. - In the Azure portal, go to your Azure Key Vault and assign the **Owner** role to the registered application. - This can be done from `Role assignment` section of `Access control (IAM)` tab (in the left-side-navbar of your Azure Key Vault in the Azure portal)
_Doing this would allow the registered application manage the resource, i.e., entity creation, deletion, etc.,_
-- For more information on securing your Key Vault: [Learn more](https://docs.microsoft.com/en-us/azure/key-vault/general/secure-your-key-vault) +- For more information on securing your Key Vault: [Learn more](https://docs.microsoft.com/azure/key-vault/general/secure-your-key-vault) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fkeyvault%2Fkeyvault-secrets%2Ftest%2FREADME.png) diff --git a/sdk/monitor/monitor-opentelemetry-exporter/README.md b/sdk/monitor/monitor-opentelemetry-exporter/README.md index 42444ddbedc6..62377eb45c40 100644 --- a/sdk/monitor/monitor-opentelemetry-exporter/README.md +++ b/sdk/monitor/monitor-opentelemetry-exporter/README.md @@ -13,7 +13,7 @@ This exporter package assumes your application is [already instrumented](https:/ ### Prerequisites You must have an [Azure subscription](https://azure.microsoft.com/free/) and a -[Application Insights workspace](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview/) to use this package. +[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.x or higher. ### Distributed Tracing diff --git a/sdk/schemaregistry/README.md b/sdk/schemaregistry/README.md index 44bdbfe2a561..9baaf92f256f 100644 --- a/sdk/schemaregistry/README.md +++ b/sdk/schemaregistry/README.md @@ -2,5 +2,5 @@ We have two client libraries for Azure Schema Registry -- `@azure/schema-registry` - The Schema Registry client for storing and retrieving schemas. You can find more info over [here](./schema-registry). -- `@azure/schema-registry-avro` - The Avro-based serializer that leverages Schema Registry. You can find more info over [here](./schema-registry-avro). +- `@azure/schema-registry` - The Schema Registry client for storing and retrieving schemas. You can find more info over [here](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry). +- `@azure/schema-registry-avro` - The Avro-based serializer that leverages Schema Registry. You can find more info over [here](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry-avro). diff --git a/sdk/schemaregistry/schema-registry-avro/samples/javascript/README.md b/sdk/schemaregistry/schema-registry-avro/samples/javascript/README.md index c4871755b022..307e68a3d394 100644 --- a/sdk/schemaregistry/schema-registry-avro/samples/javascript/README.md +++ b/sdk/schemaregistry/schema-registry-avro/samples/javascript/README.md @@ -54,7 +54,7 @@ npx cross-env ENDPOINT="" API_KEY="" node schemaRegistryAvroS Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[schemaregistrysample]: ./schemaRegistryAvroSample.js +[schemaregistrysample]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry-avro/samples/javascript/schemaRegistryAvroSample.js [apiref]: https://docs.microsoft.com/javascript/api [freesub]: https://azure.microsoft.com/free/ -[package]: ../../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry-avro/README.md diff --git a/sdk/schemaregistry/schema-registry-avro/samples/typescript/README.md b/sdk/schemaregistry/schema-registry-avro/samples/typescript/README.md index 4d0f3e342dca..f15d759b1b60 100644 --- a/sdk/schemaregistry/schema-registry-avro/samples/typescript/README.md +++ b/sdk/schemaregistry/schema-registry-avro/samples/typescript/README.md @@ -69,5 +69,5 @@ Take a look at our [API Documentation][apiref] for more information about the AP [schemaregistrysample]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/schemaregistry/schema-registry-avro/samples/typescript/src/schemaRegistryAvroSample.ts [apiref]: https://docs.microsoft.com/javascript/api [freesub]: https://azure.microsoft.com/free/ -[package]: ../../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry-avro/README.md [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/schemaregistry/schema-registry/samples/javascript/README.md b/sdk/schemaregistry/schema-registry/samples/javascript/README.md index 306cc9c1bfc2..db5c119394a7 100644 --- a/sdk/schemaregistry/schema-registry/samples/javascript/README.md +++ b/sdk/schemaregistry/schema-registry/samples/javascript/README.md @@ -54,7 +54,7 @@ npx cross-env ENDPOINT="" API_KEY="" node schemaRegistrySampl Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[schemaregistrysample]: ./schemaRegistrySample.js +[schemaregistrysample]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry/samples/javascript/schemaRegistrySample.js [apiref]: https://docs.microsoft.com/javascript/api [freesub]: https://azure.microsoft.com/free/ -[package]: ../../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry/README.md diff --git a/sdk/schemaregistry/schema-registry/samples/typescript/README.md b/sdk/schemaregistry/schema-registry/samples/typescript/README.md index 817b4a92a22f..1dd07b0875a8 100644 --- a/sdk/schemaregistry/schema-registry/samples/typescript/README.md +++ b/sdk/schemaregistry/schema-registry/samples/typescript/README.md @@ -66,8 +66,8 @@ npx cross-env SCHEMA_REGISTRY_ENDPOINT="" AZURE_TENANT_ID=" Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[schemaregistrysample]: ./src/schemaRegistrySample.ts +[schemaregistrysample]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry/samples/typescript/src/schemaRegistrySample.ts [apiref]: https://docs.microsoft.com/javascript/api [freesub]: https://azure.microsoft.com/free/ -[package]: ../../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/schemaregistry/schema-registry/README.md [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/search/search-documents/test/README.md b/sdk/search/search-documents/test/README.md index d230bc7259c9..4f436651d390 100644 --- a/sdk/search/search-documents/test/README.md +++ b/sdk/search/search-documents/test/README.md @@ -6,7 +6,7 @@ The Azure Cognitive Search client does not have any recorded tests and so, all t The Azure resource that is used by the tests in this project is: -- An [Azure Cognitive Search](https://docs.microsoft.com/en-us/azure/search/search-what-is-azure-search) account. +- An [Azure Cognitive Search](https://docs.microsoft.com/azure/search/search-what-is-azure-search) account. To run the live tests, you will also need to set the below environment variables: diff --git a/sdk/servicebus/service-bus/README.md b/sdk/servicebus/service-bus/README.md index b2d3c8688176..1ca9ad9232db 100644 --- a/sdk/servicebus/service-bus/README.md +++ b/sdk/servicebus/service-bus/README.md @@ -339,7 +339,7 @@ directory for detailed examples on how to use this library to send and receive m ## Contributing -If you'd like to contribute to this library, please read the [contributing guide](../../../CONTRIBUTING.md) to learn more about how to build and test the code. +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. ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fservicebus%2Fservice-bus%2FREADME.png) @@ -353,10 +353,10 @@ If you'd like to contribute to this library, please read the [contributing guide [sender]: https://docs.microsoft.com/javascript/api/@azure/service-bus/sender?view=azure-node-preview [sender_send]: https://docs.microsoft.com/javascript/api/@azure/service-bus/sender?view=azure-node-preview#sendmessages-servicebusmessage---servicebusmessage-----servicebusmessagebatch--operationoptionsbase- [receiver]: https://docs.microsoft.com/javascript/api/@azure/service-bus/receiver?view=azure-node-preview -[receiverreceivebatch]: https://docs.microsoft.com/en-us/javascript/api/@azure/service-bus/receiver?view=azure-node-preview#receivemessages-number--receivemessagesoptions- -[receiver_subscribe]: https://docs.microsoft.com/en-us/javascript/api/@azure/service-bus/receiver?view=azure-node-preview#subscribe-messagehandlers-receivedmessaget---subscribeoptions- -[receiver_getmessageiterator]: https://docs.microsoft.com/en-us/javascript/api/@azure/service-bus/receiver?view=azure-node-preview#getmessageiterator-getmessageiteratoroptions- -[sessionreceiver]: https://docs.microsoft.com/en-us/javascript/api/@azure/service-bus/sessionreceiver?view=azure-node-preview +[receiverreceivebatch]: https://docs.microsoft.com/javascript/api/@azure/service-bus/receiver?view=azure-node-preview#receivemessages-number--receivemessagesoptions- +[receiver_subscribe]: https://docs.microsoft.com/javascript/api/@azure/service-bus/receiver?view=azure-node-preview#subscribe-messagehandlers-receivedmessaget---subscribeoptions- +[receiver_getmessageiterator]: https://docs.microsoft.com/javascript/api/@azure/service-bus/receiver?view=azure-node-preview#getmessageiterator-getmessageiteratoroptions- +[sessionreceiver]: https://docs.microsoft.com/javascript/api/@azure/service-bus/sessionreceiver?view=azure-node-preview [migrationguide]: https://github.com/Azure/azure-sdk-for-js/blob/fb53a838e702a075c4db6f1d4a17849a271342df/sdk/servicebus/service-bus/migrationguide.md [docsms_messagesessions]: https://docs.microsoft.com/azure/service-bus-messaging/message-sessions [docsms_messagesessions_fifo]: https://docs.microsoft.com/azure/service-bus-messaging/message-sessions#first-in-first-out-fifo-pattern diff --git a/sdk/servicefabric/servicefabric/README.md b/sdk/servicefabric/servicefabric/README.md index 6f87405556c3..78b97b1c0c43 100644 --- a/sdk/servicefabric/servicefabric/README.md +++ b/sdk/servicefabric/servicefabric/README.md @@ -27,7 +27,7 @@ npm install @azure/ms-rest-nodeauth@"^3.0.0" ##### Sample code -[Service Fabric cluster security scenarios](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security) +[Service Fabric cluster security scenarios](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-security) ```typescript import { ServiceFabricClient } from "@azure/servicefabric"; diff --git a/sdk/storage/CONTRIBUTING.md b/sdk/storage/CONTRIBUTING.md index fa585284affe..36af20f98a57 100644 --- a/sdk/storage/CONTRIBUTING.md +++ b/sdk/storage/CONTRIBUTING.md @@ -40,7 +40,7 @@ Example - `export TEST_MODE=record` or `set TEST_MODE=record` | ACCOUNT_NAME | Name of your storage account. | Required | | ACCOUNT_KEY | Can be obtained from the Azure portal. Go to the `Access Keys` tab under the `Settings` section of your storage account in the portal and note down the key. | Required | | ACCOUNT_SAS | Can be obtained from the Azure portal. Go to the `Shared access signature` tab under the `Settings` section of your storage account in the portal. Generate SAS by enabling permissions, setting exiry dates, etc. You can also generate SAS from tools like Azure Storage Explorer.
A SAS starts with "?". And if you are using Windows CMD, you may need quotes to escape special characters like this - `set "ACCOUNT_SAS="` | Required to run the browser tests | - | ACCOUNT_TOKEN | Preferred way is to get a Token through Azure CLI.
- `az login`
- `az account get-access-token --resource "https://storage.azure.com"`
For more info - refer [Azure CLI - get-access-token](https://docs.microsoft.com/en-us/cli/azure/account?view=azure-cli-latest#az-account-get-access-token) | Not required (Some of the tests will be skipped if this variable is not defined) | + | ACCOUNT_TOKEN | Preferred way is to get a Token through Azure CLI.
- `az login`
- `az account get-access-token --resource "https://storage.azure.com"`
For more info - refer [Azure CLI - get-access-token](https://docs.microsoft.com/cli/azure/account?view=azure-cli-latest#az-account-get-access-token) | Not required (Some of the tests will be skipped if this variable is not defined) | | STORAGE_CONNECTION_STRING | Can be obtained from the Azure portal. Go to the `Access Keys` tab under the `Settings` section of your storage account in the portal and note down the connection string. | Required | | ENCRYPTION_SCOPE_1 | An encryption scope created under your storage account. The two encryption scopes need to be different. Can be created using the SRP API. | Not required (Some of the tests will be skipped if this variable is not defined) | | ENCRYPTION_SCOPE_2 | Another encryption scope created under your storage account. The two encryption scopes need to be different. Can be created using the SRP API. | Not required (Some of the tests will be skipped if this variable is not defined) | @@ -57,7 +57,7 @@ The environment variable **TEST_MODE** controls how the tests are running. - Else If TEST_MODE = "playback" (or if the TEST_MODE is not set or set to an invalid value), - Existing recordings are played back as responses to the HTTP requests in the tests -Please refer to the [guidelines on Record and Playback](./../test-utils/recorder/GUIDELINES.md) for more details. +Please refer to the [guidelines on Record and Playback](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/test-utils/recorder/GUIDELINES.md) for more details. ### Emulator Tests @@ -156,7 +156,7 @@ npm run test `npm run test` would run the the tests in both node and the browser. -**Link** - [Guidelines for record and playback - `@azure/test-utils-recorder`](./../test-utils/recorder/GUIDELINES.md) +**Link** - [Guidelines for record and playback - `@azure/test-utils-recorder`](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/test-utils/recorder/GUIDELINES.md) ## Pull Requests diff --git a/sdk/storage/README.md b/sdk/storage/README.md index a24aae413ef0..66c005ceaf1c 100644 --- a/sdk/storage/README.md +++ b/sdk/storage/README.md @@ -8,13 +8,13 @@ This project provides client libraries in JavaScript that makes it easy to consu - [Source Code - File Data Lake](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-file-datalake) - [Source Code - File Share](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-file-share) - [Source Code - Queue](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-queue) -- [Product documentation](https://docs.microsoft.com/en-us/azure/storage) +- [Product documentation](https://docs.microsoft.com/azure/storage) - @azure/storage-blob [Package (npm)](https://www.npmjs.com/package/@azure/storage-blob) - @azure/storage-file-datalake [Package (npm)](https://www.npmjs.com/package/@azure/storage-file-datalake) - @azure/storage-file-share [Package (npm)](https://www.npmjs.com/package/@azure/storage-file-share) - @azure/storage-queue [Package (npm)](https://www.npmjs.com/package/@azure/storage-queue) - [API Reference documentation](https://docs.microsoft.com/javascript/api/overview/azure/storage-overview) -- [Azure Storage REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/) +- [Azure Storage REST APIs](https://docs.microsoft.com/rest/api/storageservices/) ## Key concepts @@ -51,7 +51,7 @@ These libraries are compatible with Node.js and browsers, and validated against The Azure Storage client libraries for JavaScript provides low-level and high-level APIs. Take Blob client library as example: -- `BlobServiceClient`, `ContainerClient` and `BlobClient` objects provide the low-level API functionality and map one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api). +- `BlobServiceClient`, `ContainerClient` and `BlobClient` objects provide the low-level API functionality and map one-to-one to the [Azure Storage Blob REST APIs](https://docs.microsoft.com/rest/api/storageservices/blob-service-rest-api). - The high-level APIs provide convenience abstractions such as uploading a large stream to a block blob (using multiple PutBlock requests). diff --git a/sdk/storage/storage-blob-changefeed/samples/README.md b/sdk/storage/storage-blob-changefeed/samples/README.md index 632f6c2dbb50..6cf37f3af92e 100644 --- a/sdk/storage/storage-blob-changefeed/samples/README.md +++ b/sdk/storage/storage-blob-changefeed/samples/README.md @@ -23,7 +23,7 @@ npm install @azure/storage-blob-changefeed ### Authenticating with Azure Active Directory -If you have [registered an application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) with an Azure Active Directory tenant, you can [assign it to an RBAC role](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad) in your Azure Storage account. This enables you to use the Azure.Identity library to authenticate with Azure Storage as shown in the [azureAdAuth.ts sample](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/src/azureAdAuth.ts). +If you have [registered an application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) with an Azure Active Directory tenant, you can [assign it to an RBAC role](https://docs.microsoft.com/azure/storage/common/storage-auth-aad) in your Azure Storage account. This enables you to use the Azure.Identity library to authenticate with Azure Storage as shown in the [azureAdAuth.ts sample](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/src/azureAdAuth.ts). ## JavaScript sample diff --git a/sdk/storage/storage-blob/CHANGELOG.md b/sdk/storage/storage-blob/CHANGELOG.md index d5d04d749b10..8f22db2ee7de 100644 --- a/sdk/storage/storage-blob/CHANGELOG.md +++ b/sdk/storage/storage-blob/CHANGELOG.md @@ -37,7 +37,7 @@ ## 12.1.1 (2020.03) -- Bug fix - Blob SAS's `sr` field is now properly set when generating SAS for a blob using a stored policy with `signedpermissions`. For more details about Service SAS, please refer to [link](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas). +- Bug fix - Blob SAS's `sr` field is now properly set when generating SAS for a blob using a stored policy with `signedpermissions`. For more details about Service SAS, please refer to [link](https://docs.microsoft.com/rest/api/storageservices/create-service-sas). - Fixed unexpected hang issue when uploading empty body. Fixed bug [6904](https://github.com/Azure/azure-sdk-for-js/issues/6904). ## 12.1.0 (2020.02) @@ -232,7 +232,7 @@ - A new option `keepAliveOptions` added to parameter of `newPipeline()` which controls keep-alive configurations. Keep-alive is enabled by default. - Pass through `options.abortSignal` to the optional `abortSignal` attribute in option bags instead of using `AbortSignal.none` as the default value when `options.abortSignal` is not specified. - Basic HTTP proxy authentication support is added. Proxy settings can be passed in the options while creating a new client. Example - [typescript/proxyAuth.ts](https://github.com/Azure/azure-sdk-for-js/blob/@azure/storage-blob_12.0.0-preview.3/sdk/storage/storage-blob/samples/typescript/proxyAuth.ts) -- Connection strings for explicit storage endpoints are supported. - [Configure Azure Storage connection strings](https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-explicit-storage-endpoint) +- Connection strings for explicit storage endpoints are supported. - [Configure Azure Storage connection strings](https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-explicit-storage-endpoint) ## 12.0.0-preview.2 (2019.08) @@ -298,7 +298,7 @@ For release notes and more information please visit https://aka.ms/azsdk/release ## 10.4.0 (2019.07) -- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/en-us/rest/api/storageservices/version-2018-11-09). +- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/rest/api/storageservices/version-2018-11-09). - Improved comments for `BlockBlobURL.upload()`. - Exported `HttpRequestBody` type for who wants to implement a customized HTTP client. - Fixed a bug of `downloadBlobToBuffer()` and `downloadAzureFileToBuffer()` when provided offset is not 0. diff --git a/sdk/storage/storage-blob/samples/README.md b/sdk/storage/storage-blob/samples/README.md index 1350da9b80e5..d6bbcea2ca5c 100644 --- a/sdk/storage/storage-blob/samples/README.md +++ b/sdk/storage/storage-blob/samples/README.md @@ -23,7 +23,7 @@ npm install @azure/storage-blob ### Authenticating with Azure Active Directory -If you have [registered an application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) with an Azure Active Directory tenant, you can [assign it to an RBAC role](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad) in your Azure Storage account. This enables you to use the Azure.Identity library to authenticate with Azure Storage as shown in the [azureAdAuth.ts sample](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/src/azureAdAuth.ts). +If you have [registered an application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) with an Azure Active Directory tenant, you can [assign it to an RBAC role](https://docs.microsoft.com/azure/storage/common/storage-auth-aad) in your Azure Storage account. This enables you to use the Azure.Identity library to authenticate with Azure Storage as shown in the [azureAdAuth.ts sample](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/src/azureAdAuth.ts). ## Javascript sample diff --git a/sdk/storage/storage-blob/test/README.md b/sdk/storage/storage-blob/test/README.md index 1f2cd72446c9..a0a038dafcec 100644 --- a/sdk/storage/storage-blob/test/README.md +++ b/sdk/storage/storage-blob/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resource that is used by the tests in this project is: -- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. +- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. To run the live tests, you will also need to set the below environment variables: diff --git a/sdk/storage/storage-datalake/README.md b/sdk/storage/storage-datalake/README.md index 9905cb4dbee0..de8de1dce380 100644 --- a/sdk/storage/storage-datalake/README.md +++ b/sdk/storage/storage-datalake/README.md @@ -18,7 +18,7 @@ npm install @azure/storage-datalake #### nodejs - Authentication, client creation and list filesystem as an example written in TypeScript. ##### Sample code -This sample lists the file systems in your storage account. To know more, refer to the [Azure Documentation on Storage DataLake](https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction) +This sample lists the file systems in your storage account. To know more, refer to the [Azure Documentation on Storage DataLake](https://docs.microsoft.com/azure/storage/blobs/data-lake-storage-introduction) ```typescript diff --git a/sdk/storage/storage-file-datalake/samples/README.md b/sdk/storage/storage-file-datalake/samples/README.md index 34f5311bdcda..da540510afbb 100644 --- a/sdk/storage/storage-file-datalake/samples/README.md +++ b/sdk/storage/storage-file-datalake/samples/README.md @@ -23,7 +23,7 @@ npm install @azure/storage-file-datalake ### Authenticating with Azure Active Directory -If you have [registered an application](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app) with an Azure Active Directory tenant, you can [assign it to an RBAC role](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad) in your Azure Storage account. This enables you to use the Azure.Identity library to authenticate with Azure Storage. +If you have [registered an application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) with an Azure Active Directory tenant, you can [assign it to an RBAC role](https://docs.microsoft.com/azure/storage/common/storage-auth-aad) in your Azure Storage account. This enables you to use the Azure.Identity library to authenticate with Azure Storage. ## Javascript sample diff --git a/sdk/storage/storage-file-datalake/test/README.md b/sdk/storage/storage-file-datalake/test/README.md index 6778511e2f88..ce0c681f7329 100644 --- a/sdk/storage/storage-file-datalake/test/README.md +++ b/sdk/storage/storage-file-datalake/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resource that is used by the tests in this project is: -- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. +- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. To run the live tests, you will also need to set the below environment variables: diff --git a/sdk/storage/storage-file-share/CHANGELOG.md b/sdk/storage/storage-file-share/CHANGELOG.md index 8fe96a388151..fc2905e4dc2a 100644 --- a/sdk/storage/storage-file-share/CHANGELOG.md +++ b/sdk/storage/storage-file-share/CHANGELOG.md @@ -156,7 +156,7 @@ - Added `DirectoryClient.forceCloseHandlesSegment()`, `FileClient.forceCloseHandlesSegment()`, `DirectoryClient.forceCloseHandle()` and `FileClient.forceCloseHandle()` to close handles. - Pass through `options.abortSignal` to the optional `abortSignal` attribute in option bags instead of using `AbortSignal.none` as the default value when `options.abortSignal` is not specified. - Basic HTTP proxy authentication support is added. Proxy settings can be passed in the options while creating a new client. Example - [typescript/src/proxyAuth.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/samples/typescript/src/proxyAuth.ts) -- Connection strings for explicit storage endpoints are supported. - [Configure Azure Storage connection strings](https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-explicit-storage-endpoint) +- Connection strings for explicit storage endpoints are supported. - [Configure Azure Storage connection strings](https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-explicit-storage-endpoint) ## 12.0.0-preview.2 (2019.08) @@ -221,11 +221,11 @@ For release notes and more information please visit https://aka.ms/azsdk/release - Export `RetryPolicyType`. - Updated HTTP client from axios to node-fetch in Node.js runtime. - A new option `keepAliveOptions` added to parameter of `StorageURL.newPipeline()` which controls keep-alive configurations. Keep-alive is enabled by default. -- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/en-us/rest/api/storageservices/version-2018-11-09). +- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/rest/api/storageservices/version-2018-11-09). - The `ShareURL.getStatistics()` now returns the approximate size in bytes with `shareUsageBytes`. - Added `DirectoryURL.listHandlesSegment()` and `FileURL.listHandlesSegment()` to returns a list of open handles on a directory or a file. - Added `DirectoryURL.forceCloseHandlesSegment()`, `FileURL.forceCloseHandlesSegment()`, `DirectoryURL.forceCloseHandle()` and `FileURL.forceCloseHandle()` to close handles. -- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/en-us/rest/api/storageservices/version-2018-11-09). +- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/rest/api/storageservices/version-2018-11-09). ## 10.1.0 (2019.01) diff --git a/sdk/storage/storage-file-share/README.md b/sdk/storage/storage-file-share/README.md index fc5293936c6c..5ab0738a1470 100644 --- a/sdk/storage/storage-file-share/README.md +++ b/sdk/storage/storage-file-share/README.md @@ -59,7 +59,7 @@ This library depends on following ES features which need external polyfills load - `String.prototype.includes` - `Array.prototype.includes` - `Object.assign` -- `Object.keys` (Overrides the IE11's `Object.keys` with a polyfill to enable the [ES6 behavior](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys#Notes)) +- `Object.keys` (Overrides the IE11's `Object.keys` with a polyfill to enable the [ES6 behavior](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/keys#Notes)) - `Symbol` - `Symbol.iterator` diff --git a/sdk/storage/storage-file-share/test/README.md b/sdk/storage/storage-file-share/test/README.md index 5b199639a45f..d3020429ae3f 100644 --- a/sdk/storage/storage-file-share/test/README.md +++ b/sdk/storage/storage-file-share/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resource that is used by the tests in this project is: -- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. +- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. To run the live tests, you will also need to set the below environment variables: diff --git a/sdk/storage/storage-queue/CHANGELOG.md b/sdk/storage/storage-queue/CHANGELOG.md index bb36607d1b11..db4f7574a2a5 100644 --- a/sdk/storage/storage-queue/CHANGELOG.md +++ b/sdk/storage/storage-queue/CHANGELOG.md @@ -137,7 +137,7 @@ - A new option `keepAliveOptions` added to parameter of `newPipeline()` which controls keep-alive configurations. Keep-alive is enabled by default. - Pass through `options.abortSignal` to the optional `abortSignal` attribute in option bags instead of using `AbortSignal.none` as the default value when `options.abortSignal` is not specified. - Basic HTTP proxy authentication support is added. Proxy settings can be passed in the options while creating a new client. Example - [typescript/proxyAuth.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/samples/typescript/src/proxyAuth.ts) -- Connection strings for explicit storage endpoints are supported. - [Configure Azure Storage connection strings](https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-explicit-storage-endpoint) +- Connection strings for explicit storage endpoints are supported. - [Configure Azure Storage connection strings](https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string#create-a-connection-string-for-an-explicit-storage-endpoint) ## 12.0.0-preview.2 (2019.08) @@ -196,7 +196,7 @@ For release notes and more information please visit https://aka.ms/azsdk/release - Updated API version to 2018-11-09. - Updated HTTP client from axios to node-fetch in Node.js runtime. - A new option `keepAliveOptions` added to parameter of `StorageURL.newPipeline()` which controls keep-alive configurations. Keep-alive is enabled by default. -- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/en-us/rest/api/storageservices/version-2018-11-09). +- Updated Azure Storage Service API version to [2018-11-09](https://docs.microsoft.com/rest/api/storageservices/version-2018-11-09). ## 10.1.0 (2019.01) diff --git a/sdk/storage/storage-queue/test/README.md b/sdk/storage/storage-queue/test/README.md index 18752c88a1b2..84b2c43a9dfe 100644 --- a/sdk/storage/storage-queue/test/README.md +++ b/sdk/storage/storage-queue/test/README.md @@ -6,7 +6,7 @@ You can use existing Azure resources for the live tests, or generate new ones by The Azure resources that are used by the tests in this project are: -- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. +- Two general purpose, v2 [Azure Storage](https://docs.microsoft.com/azure/storage/common/storage-account-overview) account properly configured to test the Azure Storage Blob, Azure Storage Queue, Azure File Data Lake and Azure File Share services. You will also need to set the below environment variables to run the live tests: diff --git a/sdk/template/template/README-TEMPLATE.md b/sdk/template/template/README-TEMPLATE.md index d77bdad7a5c3..159c6dedd21a 100644 --- a/sdk/template/template/README-TEMPLATE.md +++ b/sdk/template/template/README-TEMPLATE.md @@ -397,7 +397,7 @@ If you'd like to contribute to this library, please read the [contributing guide [azure_cli]: https://docs.microsoft.com/cli/azure [azure_sub]: https://azure.microsoft.com/free/ -[cognitive_resource]: https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account +[cognitive_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account [azure_portal]: https://portal.azure.com [azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity [cognitive_auth]: https://docs.microsoft.com/azure/cognitive-services/authentication diff --git a/sdk/template/template/README.md b/sdk/template/template/README.md index 75848454be94..a44b124f0ae2 100644 --- a/sdk/template/template/README.md +++ b/sdk/template/template/README.md @@ -23,5 +23,5 @@ Tests follow a similar pipeline, however test output is under `dist-test` folder ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Ftemplate%2Ftemplate%2FREADME.png) [readme_template]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/template/template/README-TEMPLATE.md -[azsdk_doc_guidelines]: https://review.docs.microsoft.com/en-us/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#readme +[azsdk_doc_guidelines]: https://review.docs.microsoft.com/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#readme [contributing_guide]: https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md diff --git a/sdk/test-utils/perfstress/README.md b/sdk/test-utils/perfstress/README.md index b436996be5ec..8e73277e5083 100644 --- a/sdk/test-utils/perfstress/README.md +++ b/sdk/test-utils/perfstress/README.md @@ -73,7 +73,7 @@ npm run perfstress-test:node -- MyTest --warmup 2 --duration 4 --iterations 2 ## Examples -Check the [test folder](./test/). +Check the [test folder](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/test-utils/perfstress/test/). ## Troubleshooting @@ -81,7 +81,7 @@ TODO ## Next steps -Check the [source](./src/) folder and the [test folder](./test/). +Check the [source](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/test-utils/perfstress/src/) folder and the [test folder](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/test-utils/perfstress/test/). Also check the PerfStress EPIC, here: https://github.com/Azure/azure-sdk-for-js/issues/8057