diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a71f674c293d..3bdfc41f0a3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -218,7 +218,7 @@ Generally speaking, the following commands are roughly equivalent: ## Onboarding a new library -To add a new library to the repo, update `rush.json` in the root of the repo and add a new entry to the `projects` array at the bottom of the file. The package name must be the full name of the package as specified in its package.json. Your new library must follow our [repository structure](https://github.com/Azure/azure-sdk/blob/master/docs/engineering-system/repo-structure.md) (specifically, it must be located at `sdk//`) and your library's package.json must contain the required scripts as documented [above](#other-npm-scripts). Once the library is added, run `rush update` to install and link dependencies. If your new library has introduced a dependency version conflict, this command will fail. See [above](#resolving-dependency-version-conflicts) to learn how to resolve dependency version conflicts. +To add a new library to the repo, update `rush.json` in the root of the repo and add a new entry to the `projects` array at the bottom of the file. The package name must be the full name of the package as specified in its package.json. Your new library must follow our [repository structure](https://github.com/Azure/azure-sdk/blob/master/docs/policies/repostructure.md) (specifically, it must be located at `sdk//`) and your library's package.json must contain the required scripts as documented [above](#other-npm-scripts). Once the library is added, run `rush update` to install and link dependencies. If your new library has introduced a dependency version conflict, this command will fail. See [above](#resolving-dependency-version-conflicts) to learn how to resolve dependency version conflicts. Rush assumes that anything printed to `STDERR` is a warning. Your package scripts should avoid writing to `STDERR` unless emitting warnings or errors, since this will cause Rush to flag them as warnings during the execution of your build or script command. If your library uses a tool that can't be configured this way, you can still append `2>&1` to the command which will redirect all output to `STDOUT`. You won't see warnings show up, but Rush will still consider the command to have failed as long as it returns a nonzero exit code. diff --git a/common/tools/eslint-plugin-azure-sdk/README.md b/common/tools/eslint-plugin-azure-sdk/README.md index 6968a6dacdf2..afe2c380a57c 100644 --- a/common/tools/eslint-plugin-azure-sdk/README.md +++ b/common/tools/eslint-plugin-azure-sdk/README.md @@ -80,45 +80,45 @@ Some rules (see table below) are fixable using the `--fix` ESLint option (added | Rule | Default | Fixable | Release | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | ------------------ | ------- | -| [**github-source-headers**](/tools/eslint-plugin-azure-sdk/docs/rules/github-source-headers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | -| [**ts-apisurface-standardized-verbs**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-standardized-verbs.md) | :triangular_flag_on_post: | :x: | `1.2.0` | -| [**ts-apisurface-supportcancellation**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-supportcancellation.md) | :triangular_flag_on_post: | :x: | `1.2.0` | -| [**ts-config-allowsyntheticdefaultimports**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-allowsyntheticdefaultimports.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-declaration**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-declaration.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-esmoduleinterop**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-esmoduleinterop.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-exclude**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-exclude.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-forceconsistentcasinginfilenames**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-forceconsistentcasinginfilenames.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-importhelpers**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-importhelpers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-lib**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-lib.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-module**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-moduleresolution**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-moduleresolution.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | -| [**ts-config-no-experimentaldecorators**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-no-experimentaldecorators.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-sourcemap**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-sourcemap.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-strict**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-strict.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-config-target**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-target.md) | :triangular_flag_on_post: | :x: | `1.1.0` | -| [**ts-doc-internal**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-doc-internal.md) | :triangular_flag_on_post: | :x: | `1.1.0` | -| [**ts-error-handling**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-error-handling.md) | :heavy_multiplication_x: | :x: | `1.1.0` | -| [**ts-modules-only-named**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-modules-only-named.md) | :triangular_flag_on_post: | :x: | `1.1.0` | -| [**ts-naming-drop-noun**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-drop-noun.md) | :triangular_flag_on_post: | :x: | `1.2.0` | -| [**ts-naming-options**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-options.md) | :triangular_flag_on_post: | :x: | `1.2.0` | -| [**ts-naming-subclients**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-subclients.md) | :triangular_flag_on_post: | :x: | `1.2.0` | -| [**ts-no-const-enums**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-const-enums.md) | :warning: | :heavy_check_mark: | `1.1.0` | -| [**ts-no-namespaces**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-namespaces.md) | :triangular_flag_on_post: | :x: | `1.2.0` | -| [**ts-package-json-author**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-author.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-package-json-bugs**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-bugs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-package-json-engine-is-present**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-engine-is-present.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | -| [**ts-package-json-files-required**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-files-required.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | -| [**ts-package-json-homepage**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-homepage.md) | :triangular_flag_on_post: | :x: | `1.0.0` | -| [**ts-package-json-keywords**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-keywords.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-package-json-license**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-license.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-package-json-main-is-cjs**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-main-is-cjs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | -| [**ts-package-json-module**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | -| [**ts-package-json-name**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-name.md) | :triangular_flag_on_post: | :x: | `1.0.0` | -| [**ts-package-json-repo**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-repo.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-package-json-required-scripts**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-required-scripts.md) | :triangular_flag_on_post: | :x: | `1.0.0` | -| [**ts-package-json-sideeffects**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-sideeffects.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | -| [**ts-package-json-types**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-types.md) | :triangular_flag_on_post: | :x: | `1.1.0` | -| [**ts-pagination-list**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-pagination-list.md) | :triangular_flag_on_post: | :x: | `1.2.0` | -| [**ts-use-interface-parameters**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-interface-parameters.md) | :warning: | :x: | `1.1.0` | -| [**ts-use-promises**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-promises.md) | :triangular_flag_on_post: | :x: | `1.1.0` | -| [**ts-versioning-semver**](/tools/eslint-plugin-azure-sdk/docs/rules/ts-versioning-semver.md) | :triangular_flag_on_post: | :x: | `1.1.0` | +| [**github-source-headers**]https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/github-source-headers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | +| [**ts-apisurface-standardized-verbs**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-standardized-verbs.md) | :triangular_flag_on_post: | :x: | `1.2.0` | +| [**ts-apisurface-supportcancellation**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-supportcancellation.md) | :triangular_flag_on_post: | :x: | `1.2.0` | +| [**ts-config-allowsyntheticdefaultimports**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-allowsyntheticdefaultimports.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-declaration**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-declaration.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-esmoduleinterop**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-esmoduleinterop.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-exclude**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-exclude.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-forceconsistentcasinginfilenames**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-forceconsistentcasinginfilenames.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-importhelpers**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-importhelpers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-lib**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-lib.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-module**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-moduleresolution**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-moduleresolution.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | +| [**ts-config-no-experimentaldecorators**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-no-experimentaldecorators.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-sourcemap**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-sourcemap.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-strict**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-strict.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-config-target**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-target.md) | :triangular_flag_on_post: | :x: | `1.1.0` | +| [**ts-doc-internal**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-doc-internal.md) | :triangular_flag_on_post: | :x: | `1.1.0` | +| [**ts-error-handling**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-error-handling.md) | :heavy_multiplication_x: | :x: | `1.1.0` | +| [**ts-modules-only-named**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-modules-only-named.md) | :triangular_flag_on_post: | :x: | `1.1.0` | +| [**ts-naming-drop-noun**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-drop-noun.md) | :triangular_flag_on_post: | :x: | `1.2.0` | +| [**ts-naming-options**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-options.md) | :triangular_flag_on_post: | :x: | `1.2.0` | +| [**ts-naming-subclients**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-subclients.md) | :triangular_flag_on_post: | :x: | `1.2.0` | +| [**ts-no-const-enums**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-const-enums.md) | :warning: | :heavy_check_mark: | `1.1.0` | +| [**ts-no-namespaces**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-namespaces.md) | :triangular_flag_on_post: | :x: | `1.2.0` | +| [**ts-package-json-author**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-author.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-package-json-bugs**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-bugs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-package-json-engine-is-present**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-engine-is-present.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | +| [**ts-package-json-files-required**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-files-required.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | +| [**ts-package-json-homepage**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-homepage.md) | :triangular_flag_on_post: | :x: | `1.0.0` | +| [**ts-package-json-keywords**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-keywords.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-package-json-license**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-license.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-package-json-main-is-cjs**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-main-is-cjs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | +| [**ts-package-json-module**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` | +| [**ts-package-json-name**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-name.md) | :triangular_flag_on_post: | :x: | `1.0.0` | +| [**ts-package-json-repo**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-repo.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-package-json-required-scripts**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-required-scripts.md) | :triangular_flag_on_post: | :x: | `1.0.0` | +| [**ts-package-json-sideeffects**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-sideeffects.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` | +| [**ts-package-json-types**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-types.md) | :triangular_flag_on_post: | :x: | `1.1.0` | +| [**ts-pagination-list**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-pagination-list.md) | :triangular_flag_on_post: | :x: | `1.2.0` | +| [**ts-use-interface-parameters**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-interface-parameters.md) | :warning: | :x: | `1.1.0` | +| [**ts-use-promises**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-promises.md) | :triangular_flag_on_post: | :x: | `1.1.0` | +| [**ts-versioning-semver**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-versioning-semver.md) | :triangular_flag_on_post: | :x: | `1.1.0` | diff --git a/eng/common/pipelines/templates/steps/verify-links.yml b/eng/common/pipelines/templates/steps/verify-links.yml index 1a99350f0161..2437121ba70c 100644 --- a/eng/common/pipelines/templates/steps/verify-links.yml +++ b/eng/common/pipelines/templates/steps/verify-links.yml @@ -1,5 +1,6 @@ parameters: Directory: 'not-specified' + IgnoreLinksFile: "$(Build.SourcesDirectory)/eng/ignore-links.txt" steps: - task: PowerShell@2 @@ -9,4 +10,4 @@ steps: workingDirectory: $(Build.SourcesDirectory)/${{ parameters.Directory }} filePath: eng/common/scripts/Verify-Links.ps1 arguments: > - -urls $(dir -r -i *.md) -rootUrl "file://$(Build.SourcesDirectory)/${{ parameters.Directory }}" + -urls $(dir -r -i *.md) -rootUrl "file://$(Build.SourcesDirectory)/${{ parameters.Directory }}" -recursive:$false -ignoreLinksFile "${{ parameters.IgnoreLinksFile }}" diff --git a/eng/ignore-links.txt b/eng/ignore-links.txt new file mode 100644 index 000000000000..8a4e8b53f695 --- /dev/null +++ b/eng/ignore-links.txt @@ -0,0 +1,9 @@ +https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/samples +https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/samples/javascript +https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/samples/typescript +https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/test/ +https://docs.microsoft.com/javascript/api/@azure/keyvault-admin +https://docs.microsoft.com/javascript/api/@azure/storage-blob-changefeed +https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-blob-changefeed/samples/javascript +https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-blob-changefeed/samples/typescript +https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-blob-changefeed/test/ diff --git a/eng/pipelines/aggregate-reports.yml b/eng/pipelines/aggregate-reports.yml index 1dd1440dd1bb..a9609853969e 100644 --- a/eng/pipelines/aggregate-reports.yml +++ b/eng/pipelines/aggregate-reports.yml @@ -10,6 +10,10 @@ jobs: inputs: versionSpec: 10.x + - template: ../common/pipelines/templates/steps/verify-links.yml + parameters: + Directory: "" + - script: 'npm ci' workingDirectory: '$(Build.SourcesDirectory)/eng/tools/analyze-deps' displayName: 'Install tool dependencies' diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index a4a16469f216..e2a9a9dbb201 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -55,13 +55,6 @@ jobs: 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: | @@ -140,6 +133,10 @@ jobs: parameters: SourceDirectory: $(Build.SourcesDirectory) + - template: ../../../common/pipelines/templates/steps/verify-links.yml + parameters: + Directory: sdk/${{ parameters.ServiceDirectory }} + - script: | npm ci workingDirectory: $(System.DefaultWorkingDirectory)/eng/tools/analyze-deps diff --git a/sdk/core/core-lro/samples/README.md b/sdk/core/core-lro/samples/README.md index f77dcef1a185..714e0554955f 100644 --- a/sdk/core/core-lro/samples/README.md +++ b/sdk/core/core-lro/samples/README.md @@ -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](../../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](../../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/dev.md b/sdk/cosmosdb/cosmos/dev.md index 38f721e0e992..22abfabbc52b 100644 --- a/sdk/cosmosdb/cosmos/dev.md +++ b/sdk/cosmosdb/cosmos/dev.md @@ -86,6 +86,4 @@ You can also build via the configured tasks (`build` does a full build, and `com Build the SDK and make sure the tests run before you try any samples (they depend on the SDK) -- [TodoApp](./samples/TodoApp) - We recommend using [VS code's multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) for testing the samples, especially if you're using the samples to test the SDK. There is a `launch.json` for the samples thave have been updated and multi-root workspaces will show all `launch.json`s. diff --git a/sdk/eventhub/event-hubs/CHANGELOG.md b/sdk/eventhub/event-hubs/CHANGELOG.md index a1259419a1d8..68197b90458c 100644 --- a/sdk/eventhub/event-hubs/CHANGELOG.md +++ b/sdk/eventhub/event-hubs/CHANGELOG.md @@ -263,7 +263,7 @@ For more information, please visit https://aka.ms/azsdk/releases/july2019preview ## 2.1.0 (2019-06-10) - Added support for WebSockets. WebSockets enable Event Hubs to work over an HTTP proxy and in environments where the standard AMQP port 5671 is blocked. - Refer to the [websockets](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/event-hubs/samples/websockets.ts) sample to see how to use WebSockets. + Refer to the [websockets](https://github.com/Azure/azure-sdk-for-js/blob/@azure/event-hubs_2.1.0/sdk/eventhub/event-hubs/samples/websockets.ts) sample to see how to use WebSockets. - `@types/async-lock` has been moved to being a dependency from a dev-dependency. This fixes the [bug 3240](https://github.com/Azure/azure-sdk-for-js/issues/3240) ## 2.0.0 (2019-03-26) @@ -351,7 +351,7 @@ For more information, please visit https://aka.ms/azsdk/releases/july2019preview ## 0.2.6 (2018-08-07) - Improved log statements. -- Documented different mechanisms of getting the debug logs in [README](https://github.com/Azure/azure-sdk-for-js/tree/master/eventhub/event-hubs/#debug-logs). +- Documented different mechanisms of getting the debug logs in [README](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-hubs//#debug-logs). - Minimum dependency on `"rhea": "^0.2.18"`. - Fixed bugs in recovery logic - Added support to recover from session close for sender and receiver @@ -359,7 +359,7 @@ For more information, please visit https://aka.ms/azsdk/releases/july2019preview - Using `is_closed()` method of sender, receiver and session in rhea to determine whether the sdk initiated the close. - MessagingError is retryable by default. - Added support to translate node.js [`SystemError`](https://nodejs.org/api/errors.html#errors_class_systemerror) into AmqpError. -- Added a new static method `createFromTokenProvider()` on the EventHubClient where customers can provide their own [TokenProvider](https://github.com/Azure/azure-event-hubs-node/blob/master/client/lib/amqp-common/auth/token.ts#L42). +- Added a new static method `createFromTokenProvider()` on the EventHubClient where customers can provide their own [TokenProvider](https://github.com/Azure/azure-event-hubs-node/blob/v0.2.6-EH-August2018/client/lib/amqp-common/auth/token.ts#L42). ## 0.2.5 (2018-07-17) @@ -411,7 +411,7 @@ const client = await EventHubClient.createFromIotHubConnectionString( - Created an options object in the `client.createFromConnectionString()` and the `EventHubClient` constructor. This is a breaking change. However moving to an options object design reduces the chances of breaking changes in the future. This options object will: - have the existing optional `tokenProvider` property -- and a new an optional property named `dataTransformer`. You can provide your own transformer. If not provided then we will use the [DefaultDataTransformer](./client/lib/dataTransformer.ts). This should be applicable for majority of the scenarios and will ensure that messages are interoperable between different Azure services. It fixes issue #60. +- and a new an optional property named `dataTransformer`. You can provide your own transformer. If not provided then we will use the [DefaultDataTransformer](https://github.com/Azure/azure-event-hubs-node/blob/v0.2.0-EH-May2018/client/lib/dataTransformer.ts). This should be applicable for majority of the scenarios and will ensure that messages are interoperable between different Azure services. It fixes issue #60. ## 0.1.2 (2018-04-26) @@ -424,7 +424,7 @@ const client = await EventHubClient.createFromIotHubConnectionString( ## 0.1.0 (2018-04-23) - Previously we were depending on [amqp10](https://npmjs.com/package/amqp10) package for the amqp protocol. Moving forward we will be depending on [rhea](https://npmjs.com/package/rhea). -- The public facing API of this library has major breaking changes from the previous version 0.0.8. Please take a look at the [Readme](./README.md) and the [samples](./samples) directory for detailed samples. +- The public facing API of this library has major breaking changes from the previous version 0.0.8. Please take a look at the [Readme](https://github.com/Azure/azure-event-hubs-node/blob/v0.1.0-April2018/README.md) and the [examples](https://github.com/Azure/azure-event-hubs-node/tree/v0.1.0-April2018/examples) directory for detailed samples. - Removed the need to say `client.open.then()`. First call to create a sender, receiver or get metadata about the hub or partition will establish the AMQP connection. - Added support to authenticate via Service Principal credentials, MSITokenCredentials, DeviceTokenCredentials. - This should make it easy for customers to login once using the above mentioned credentials, diff --git a/sdk/eventhub/event-processor-host/CHANGELOG.md b/sdk/eventhub/event-processor-host/CHANGELOG.md index 39d5dc8279b0..ec0290eaa6a9 100644 --- a/sdk/eventhub/event-processor-host/CHANGELOG.md +++ b/sdk/eventhub/event-processor-host/CHANGELOG.md @@ -85,7 +85,7 @@ - `onEphError` - `leaseRenewInterval` - `leaseDuration` -- Please take a look at the [examples](https://github.com/Azure/azure-sdk-for-js/tree/master/eventhub/event-processor-host/samples) for more details. +- Please take a look at the [examples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-processor-host/samples) for more details. ## 0.1.4 (2018-07-16) diff --git a/sdk/keyvault/keyvault-admin/README.md b/sdk/keyvault/keyvault-admin/README.md index edafb0431ff9..f38b4cf11dfc 100644 --- a/sdk/keyvault/keyvault-admin/README.md +++ b/sdk/keyvault/keyvault-admin/README.md @@ -58,9 +58,9 @@ setLogLevel("info"); You can find more code samples through the following links: -- [KeyVault Admin Samples (JavaScript)](./samples/javascript) -- [KeyVault Admin Samples (TypeScript)](./samples/typescript) -- [KeyVault Admin Test Cases](./test/) +- [KeyVault Admin Samples (JavaScript)](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/samples/javascript) +- [KeyVault Admin Samples (TypeScript)](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/samples/typescript) +- [KeyVault Admin Test Cases](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-admin/test/) ## Contributing diff --git a/sdk/keyvault/keyvault-certificates/README.md b/sdk/keyvault/keyvault-certificates/README.md index 7d9ca7e9fec6..7e58941c2bf5 100644 --- a/sdk/keyvault/keyvault-certificates/README.md +++ b/sdk/keyvault/keyvault-certificates/README.md @@ -91,7 +91,7 @@ Use the [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to creat ## Authenticating with Azure Active Directory -The Key Vault service relies on Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. The [README for `@azure/identity`](/sdk/identity/identity/README.md) provides more details and samples to get you started. +The Key Vault service relies on Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. The [README for `@azure/identity`](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md) provides more details and samples to get you started. Here's a quick example. First, import `DefaultAzureCredential` and `CertificateClient`: diff --git a/sdk/keyvault/keyvault-certificates/samples/javascript/README.md b/sdk/keyvault/keyvault-certificates/samples/javascript/README.md index 09262b162ccb..0960fa7c19fa 100644 --- a/sdk/keyvault/keyvault-certificates/samples/javascript/README.md +++ b/sdk/keyvault/keyvault-certificates/samples/javascript/README.md @@ -66,17 +66,17 @@ npx cross-env KEYVAULT_NAME="" AZURE_TENANT_ID="" Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[backupandrestore]: ./backupAndRestore.js -[contacts]: ./contacts.js -[deleteandrecover]: ./deleteAndRecover.js -[helloworld]: ./helloWorld.js -[issuers]: ./issuers.js -[listcertificates]: ./listCertificates.js -[mergecertificate]: ./mergeCertificate.js -[operations]: ./operations.js -[purgeAllCertificates]: ./purgeAllCertificates.js +[backupandrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/backupAndRestore.js +[contacts]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/contacts.js +[deleteandrecover]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/deleteAndRecover.js +[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/helloWorld.js +[issuers]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/issuers.js +[listcertificates]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/listCertificates.js +[mergecertificate]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/mergeCertificate.js +[operations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/operations.js +[purgeAllCertificates]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/javascript/purgeAllCertificates.js [apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-certificates [azkeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal [kvsoftdelete]: https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-cli [freesub]: https://azure.microsoft.com/free/ -[package]: ../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/README.md diff --git a/sdk/keyvault/keyvault-certificates/samples/typescript/README.md b/sdk/keyvault/keyvault-certificates/samples/typescript/README.md index 49c581d5f907..6d2752f2f35c 100644 --- a/sdk/keyvault/keyvault-certificates/samples/typescript/README.md +++ b/sdk/keyvault/keyvault-certificates/samples/typescript/README.md @@ -78,18 +78,18 @@ npx cross-env KEYVAULT_NAME="" AZURE_TENANT_ID="" Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[backupandrestore]: ./src/backupAndRestore.ts -[contacts]: ./src/contacts.ts -[deleteandrecover]: ./src/deleteAndRecover.ts -[helloworld]: ./src/helloWorld.ts -[issuers]: ./src/issuers.ts -[listcertificates]: ./src/listCertificates.ts -[mergecertificate]: ./src/mergeCertificate.ts -[operations]: ./src/operations.ts -[purgeAllCertificates]: ./src/purgeAllCertificates.ts +[backupandrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/backupAndRestore.ts +[contacts]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/contacts.ts +[deleteandrecover]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/deleteAndRecover.ts +[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/helloWorld.ts +[issuers]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/issuers.ts +[listcertificates]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/listCertificates.ts +[mergecertificate]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/mergeCertificate.ts +[operations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/operations.ts +[purgeAllCertificates]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/samples/typescript/src/purgeAllCertificates.ts [apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-certificates [azkeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal [kvsoftdelete]: https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-cli [freesub]: https://azure.microsoft.com/free/ -[package]: ../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-certificates/README.md [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/keyvault/keyvault-keys/README.md b/sdk/keyvault/keyvault-keys/README.md index afbc23e943b3..8d7d0815085c 100644 --- a/sdk/keyvault/keyvault-keys/README.md +++ b/sdk/keyvault/keyvault-keys/README.md @@ -121,7 +121,7 @@ Use the [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to creat ## Authenticating with Azure Active Directory -The Key Vault service relies on Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. The [README for `@azure/identity`](/sdk/identity/identity/README.md) provides more details and samples to get you started. +The Key Vault service relies on Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. The [README for `@azure/identity`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity/README.md) provides more details and samples to get you started. Here's a quick example. First, import `DefaultAzureCredential` and `KeyClient`: diff --git a/sdk/keyvault/keyvault-keys/samples/javascript/README.md b/sdk/keyvault/keyvault-keys/samples/javascript/README.md index af296fe874a8..84d45af32fc3 100644 --- a/sdk/keyvault/keyvault-keys/samples/javascript/README.md +++ b/sdk/keyvault/keyvault-keys/samples/javascript/README.md @@ -60,11 +60,11 @@ npx cross-env KEYVAULT_NAME="" AZURE_TENANT_ID="" Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[cryptography]: ./cryptography.js -[helloworld]: ./helloWorld.js -[purgeAllKeys]: ./purgeAllKeys.js +[cryptography]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/javascript/cryptography.js +[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/javascript/helloWorld.js +[purgeAllKeys]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys/samples/javascript/purgeAllKeys.js [apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-keys [azkeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal [kvsoftdelete]: https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-cli [freesub]: https://azure.microsoft.com/free/ -[package]: ../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-keys/README.md diff --git a/sdk/keyvault/keyvault-keys/samples/typescript/README.md b/sdk/keyvault/keyvault-keys/samples/typescript/README.md index 0305cc2d63c7..272cc215a601 100644 --- a/sdk/keyvault/keyvault-keys/samples/typescript/README.md +++ b/sdk/keyvault/keyvault-keys/samples/typescript/README.md @@ -72,12 +72,12 @@ npx cross-env KEYVAULT_NAME="" AZURE_TENANT_ID="" Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[cryptography]: ./src/cryptography.ts -[helloworld]: ./src/helloWorld.ts -[purgeAllKeys]: ./src/purgeAllKeys.ts +[cryptography]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/typescript/src/cryptography.ts +[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/typescript/src/helloWorld.ts +[purgeAllKeys]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/samples/typescript/src/purgeAllKeys.ts [apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-keys [azkeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal [kvsoftdelete]: https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-cli [freesub]: https://azure.microsoft.com/free/ -[package]: ../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/README.md [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/keyvault/keyvault-secrets/README.md b/sdk/keyvault/keyvault-secrets/README.md index 0267244f913b..5d5f2e43f0d9 100644 --- a/sdk/keyvault/keyvault-secrets/README.md +++ b/sdk/keyvault/keyvault-secrets/README.md @@ -19,7 +19,7 @@ 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](./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/en-us/services/key-vault/) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/keyvault/keyvault-secrets/samples) ## Getting started @@ -110,7 +110,7 @@ Use the [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to creat ## Authenticating with Azure Active Directory -The Key Vault service relies on Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. The [README for `@azure/identity`](/sdk/identity/identity/README.md) provides more details and samples to get you started. +The Key Vault service relies on Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. The [README for `@azure/identity`](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md) provides more details and samples to get you started. Here's a quick example. First, import `DefaultAzureCredential` and `SecretClient`: diff --git a/sdk/keyvault/keyvault-secrets/samples/javascript/README.md b/sdk/keyvault/keyvault-secrets/samples/javascript/README.md index 29efd116b9b7..4a684c631bd8 100644 --- a/sdk/keyvault/keyvault-secrets/samples/javascript/README.md +++ b/sdk/keyvault/keyvault-secrets/samples/javascript/README.md @@ -28,7 +28,7 @@ You need [an Azure subscription][freesub] and [an Azure Key Vault][azkeyvault] t [![](http://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-sdk-for-js%2Fmaster%2Fsdk%2Fkeyvault%2Fkeyvault-secrets%2Ftests-resources.json) -If creating the Key Vault manually using the Azure Portal, be aware that the samples require that the soft-delete feature be enabled. Our template above will enable this feature automatically, but it is possible to enable it manually using the Azure CLI. See [this page](kvsoftdelete) for more information. +If creating the Key Vault manually using the Azure Portal, be aware that the samples require that the soft-delete feature be enabled. Our template above will enable this feature automatically, but it is possible to enable it manually using the Azure CLI. See [this page][kvsoftdelete] for more information. Samples retrieve credentials to access the Key Vault from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. @@ -62,13 +62,13 @@ npx cross-env KEYVAULT_NAME="" AZURE_TENANT_ID="" Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[backupandrestore]: ./backupAndRestore.js -[deleteandrecover]: ./deleteAndRecover.js -[helloworld]: ./helloWorld.js -[listoperations]: ./listOperations.js -[purgeAllSecrets]: purgeAllSecrets.js +[backupandrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/javascript/backupAndRestore.js +[deleteandrecover]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/javascript/deleteAndRecover.js +[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/javascript/helloWorld.js +[listoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/javascript/listOperations.js +[purgeAllSecrets]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/javascript/purgeAllSecrets.js [apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-secrets [azkeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal [kvsoftdelete]: https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-cli [freesub]: https://azure.microsoft.com/free/ -[package]: ../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/README.md diff --git a/sdk/keyvault/keyvault-secrets/samples/typescript/README.md b/sdk/keyvault/keyvault-secrets/samples/typescript/README.md index c288a9686fea..f9b5952e7f95 100644 --- a/sdk/keyvault/keyvault-secrets/samples/typescript/README.md +++ b/sdk/keyvault/keyvault-secrets/samples/typescript/README.md @@ -34,7 +34,7 @@ You need [an Azure subscription][freesub] and [an Azure Key Vault][azkeyvault] t [![](http://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-sdk-for-js%2Fmaster%2Fsdk%2Fkeyvault%2Fkeyvault-secrets%2Ftests-resources.json) -If creating the Key Vault manually using the Azure Portal, be aware that the samples require that the soft-delete feature be enabled. Our template above will enable this feature automatically, but it is possible to enable it manually using the Azure CLI. See [this page](kvsoftdelete) for more information. +If creating the Key Vault manually using the Azure Portal, be aware that the samples require that the soft-delete feature be enabled. Our template above will enable this feature automatically, but it is possible to enable it manually using the Azure CLI. See [this page][kvsoftdelete] for more information. Samples retrieve credentials to access the Key Vault from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. @@ -74,14 +74,14 @@ npx cross-env KEYVAULT_NAME="" AZURE_TENANT_ID="" Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[backupandrestore]: ./src/backupAndRestore.ts -[deleteandrecover]: ./src/deleteAndRecover.ts -[helloworld]: ./src/helloWorld.ts -[listoperations]: ./src/listOperations.ts -[purgeAllSecrets]: src/purgeAllSecrets.ts +[backupandrestore]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/typescript/src/backupAndRestore.ts +[deleteandrecover]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/typescript/src/deleteAndRecover.ts +[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/typescript/src/helloWorld.ts +[listoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/typescript/src/listOperations.ts +[purgeAllSecrets]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/samples/typescript/src/purgeAllSecrets.ts [apiref]: https://docs.microsoft.com/javascript/api/@azure/keyvault-secrets [azkeyvault]: https://docs.microsoft.com/azure/key-vault/quick-create-portal [kvsoftdelete]: https://docs.microsoft.com/azure/key-vault/key-vault-soft-delete-cli [freesub]: https://azure.microsoft.com/free/ -[package]: ../README.md +[package]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-secrets/README.md [typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/search/search-documents/README.md b/sdk/search/search-documents/README.md index 6ba46ee62098..9aaf3aff42c8 100644 --- a/sdk/search/search-documents/README.md +++ b/sdk/search/search-documents/README.md @@ -19,11 +19,16 @@ Use the @azure/search-documents client library to: - Create and manage analyzers for advanced text analysis or multi-lingual content. - Optimize results through scoring profiles to factor in business logic or freshness. -[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/search/search/) | +[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/search/search-documents/) | [Package (NPM)](https://www.npmjs.com/package/@azure/search-documents) | [API reference documentation](https://aka.ms/azsdk/js/search/docs) | +<<<<<<< HEAD [REST API documentation](https://docs.microsoft.com/rest/api/searchservice/) | [Product documentation](https://docs.microsoft.com/azure/search/) +======= +[Product documentation](https://docs.microsoft.com/azure/search/) | +[Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples) +>>>>>>> 1488623e0... fix link in search-documents ## Getting started @@ -154,7 +159,7 @@ Typically you will only wish to [show a subset of search results](https://docs.m ## Examples -The following examples demonstrate the basics - please [check out our samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples) for much more. +The following examples demonstrate the basics - please [check out our samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples) for much more. * [Creating an index](#create-an-index) * [Retrieving a specific document from your index](#retrieve-a-specific-document-from-an-index) @@ -437,7 +442,7 @@ export AZURE_LOG_LEVEL=verbose* For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger). ## Next steps -* [Go further with search-documents and our samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples) +* [Go further with search-documents and our samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples) * [Watch a demo or deep dive video](https://azure.microsoft.com/resources/videos/index/?services=search) * [Read more about the Azure Cognitive Search service](https://docs.microsoft.com/azure/search/search-what-is-azure-search) diff --git a/sdk/search/search-documents/samples/javascript/README.md b/sdk/search/search-documents/samples/javascript/README.md index e90d64c1d0d7..43fa346ba75d 100644 --- a/sdk/search/search-documents/samples/javascript/README.md +++ b/sdk/search/search-documents/samples/javascript/README.md @@ -87,48 +87,48 @@ npx cross-env SEARCH_API_ENDPOINT="" SEARCH_API_KEY="" node r Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[readonly]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/readonlyQuery.js +[readonly]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/readonlyQuery.js [apiref]: https://aka.ms/azsdk/js/search/docs [search_resource]: https://docs.microsoft.com/azure/search/search-create-service-portal [freesub]: https://azure.microsoft.com/free/ -[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/README.md -[createDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/dataSourceConnections/createDataSourceConnection.js -[createOrUpdateDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/dataSourceConnections/createOrUpdateDataSourceConnection.js -[deleteDataSourceConnectionByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/dataSourceConnections/deleteDataSourceConnectionByName.js -[deleteDataSourceConnectionByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/dataSourceConnections/deleteDataSourceConnectionByObject.js -[getDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/dataSourceConnections/getDataSourceConnection.js -[listDataSourceConnectionNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/dataSourceConnections/listDataSourceConnectionNames.js -[listDataSourceConnections]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/dataSourceConnections/listDataSourceConnections.js -[createIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/createIndexer.js -[createOrUpdateIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/createOrUpdateIndexer.js -[deleteIndexerByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/deleteIndexerByName.js -[deleteIndexerByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/deleteIndexerByObject.js -[getIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/getIndexer.js -[getIndexerStatus]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/getIndexerStatus.js -[listIndexerNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/listIndexerNames.js -[listIndexers]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/listIndexers.js -[resetIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/resetIndexer.js -[runIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexers/runIndexer.js -[analyzeText]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/analyzeText.js -[createIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/createIndex.js -[createOrUpdateIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/createOrUpdateIndex.js -[deleteIndexByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/deleteIndexByName.js -[deleteIndexByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/deleteIndexByObject.js -[getIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/getIndex.js -[getIndexStatistics]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/getIndexStatistics.js -[listIndexes]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/listIndexes.js -[listIndexNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/indexes/listIndexNames.js -[createOrUpdateSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/skillSets/createOrUpdateSkillset.js -[createSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/skillSets/createSkillset.js -[deleteSkillsetByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/skillSets/deleteSkillsetByName.js -[deleteSkillsetByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/skillSets/deleteSkillsetByObject.js -[getSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/skillSets/getSkillset.js -[listSkillsets]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/skillSets/listSkillsets.js -[listSkillsetsNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/skillSets/listSkillsetsNames.js -[createOrUpdateSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/synonymMaps/createOrUpdateSynonymMap.js -[createSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/synonymMaps/createSynonymMap.js -[deleteSynonymMapByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/synonymMaps/deleteSynonymMapByName.js -[deleteSynonymMapByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/synonymMaps/deleteSynonymMapByObject.js -[getSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/synonymMaps/getSynonymMap.js -[listSynonymMapNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/synonymMaps/listSynonymMapNames.js -[listSynonymMaps]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/javascript/src/synonymMaps/listSynonymMaps.js +[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/README.md +[createDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/dataSourceConnections/createDataSourceConnection.js +[createOrUpdateDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/dataSourceConnections/createOrUpdateDataSourceConnection.js +[deleteDataSourceConnectionByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/dataSourceConnections/deleteDataSourceConnectionByName.js +[deleteDataSourceConnectionByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/dataSourceConnections/deleteDataSourceConnectionByObject.js +[getDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/dataSourceConnections/getDataSourceConnection.js +[listDataSourceConnectionNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/dataSourceConnections/listDataSourceConnectionNames.js +[listDataSourceConnections]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/dataSourceConnections/listDataSourceConnections.js +[createIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/createIndexer.js +[createOrUpdateIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/createOrUpdateIndexer.js +[deleteIndexerByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/deleteIndexerByName.js +[deleteIndexerByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/deleteIndexerByObject.js +[getIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/getIndexer.js +[getIndexerStatus]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/getIndexerStatus.js +[listIndexerNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/listIndexerNames.js +[listIndexers]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/listIndexers.js +[resetIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/resetIndexer.js +[runIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexers/runIndexer.js +[analyzeText]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/analyzeText.js +[createIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/createIndex.js +[createOrUpdateIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/createOrUpdateIndex.js +[deleteIndexByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/deleteIndexByName.js +[deleteIndexByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/deleteIndexByObject.js +[getIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/getIndex.js +[getIndexStatistics]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/getIndexStatistics.js +[listIndexes]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/listIndexes.js +[listIndexNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/indexes/listIndexNames.js +[createOrUpdateSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/skillSets/createOrUpdateSkillset.js +[createSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/skillSets/createSkillset.js +[deleteSkillsetByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/skillSets/deleteSkillsetByName.js +[deleteSkillsetByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/skillSets/deleteSkillsetByObject.js +[getSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/skillSets/getSkillset.js +[listSkillsets]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/skillSets/listSkillsets.js +[listSkillsetsNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/skillSets/listSkillsetsNames.js +[createOrUpdateSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/synonymMaps/createOrUpdateSynonymMap.js +[createSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/synonymMaps/createSynonymMap.js +[deleteSynonymMapByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/synonymMaps/deleteSynonymMapByName.js +[deleteSynonymMapByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/synonymMaps/deleteSynonymMapByObject.js +[getSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/synonymMaps/getSynonymMap.js +[listSynonymMapNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/synonymMaps/listSynonymMapNames.js +[listSynonymMaps]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/javascript/src/synonymMaps/listSynonymMaps.js diff --git a/sdk/search/search-documents/samples/typescript/README.md b/sdk/search/search-documents/samples/typescript/README.md index 75f4170a4b41..7964503663ad 100644 --- a/sdk/search/search-documents/samples/typescript/README.md +++ b/sdk/search/search-documents/samples/typescript/README.md @@ -99,49 +99,49 @@ npx cross-env SEARCH_API_ENDPOINT="" SEARCH_API_KEY="" node d Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. -[readonly]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/readonlyQuery.ts +[readonly]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/readonlyQuery.ts [apiref]: https://aka.ms/azsdk/js/search/docs [search_resource]: https://docs.microsoft.com/azure/search/search-create-service-portal [freesub]: https://azure.microsoft.com/free/ -[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/README.md +[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/README.md [typescript]: https://www.typescriptlang.org/docs/home.html -[createDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/dataSourceConnections/createDataSourceConnection.ts -[createOrUpdateDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/dataSourceConnections/createOrUpdateDataSourceConnection.ts -[deleteDataSourceConnectionByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/dataSourceConnections/deleteDataSourceConnectionByName.ts -[deleteDataSourceConnectionByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/dataSourceConnections/deleteDataSourceConnectionByObject.ts -[getDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/dataSourceConnections/getDataSourceConnection.ts -[listDataSourceConnectionNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/dataSourceConnections/listDataSourceConnectionNames.ts -[listDataSourceConnections]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/dataSourceConnections/listDataSourceConnections.ts -[createIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/createIndexer.ts -[createOrUpdateIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/createOrUpdateIndexer.ts -[deleteIndexerByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/deleteIndexerByName.ts -[deleteIndexerByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/deleteIndexerByObject.ts -[getIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/getIndexer.ts -[getIndexerStatus]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/getIndexerStatus.ts -[listIndexerNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/listIndexerNames.ts -[listIndexers]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/listIndexers.ts -[resetIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/resetIndexer.ts -[runIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexers/runIndexer.ts -[analyzeText]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/analyzeText.ts -[createIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/createIndex.ts -[createOrUpdateIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/createOrUpdateIndex.ts -[deleteIndexByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/deleteIndexByName.ts -[deleteIndexByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/deleteIndexByObject.ts -[getIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/getIndex.ts -[getIndexStatistics]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/getIndexStatistics.ts -[listIndexes]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/listIndexes.ts -[listIndexNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/indexes/listIndexNames.ts -[createOrUpdateSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/skillSets/createOrUpdateSkillset.ts -[createSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/skillSets/createSkillset.ts -[deleteSkillsetByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/skillSets/deleteSkillsetByName.ts -[deleteSkillsetByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/skillSets/deleteSkillsetByObject.ts -[getSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/skillSets/getSkillset.ts -[listSkillsets]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/skillSets/listSkillsets.ts -[listSkillsetsNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/skillSets/listSkillsetsNames.ts -[createOrUpdateSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/synonymMaps/createOrUpdateSynonymMap.ts -[createSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/synonymMaps/createSynonymMap.ts -[deleteSynonymMapByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/synonymMaps/deleteSynonymMapByName.ts -[deleteSynonymMapByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/synonymMaps/deleteSynonymMapByObject.ts -[getSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/synonymMaps/getSynonymMap.ts -[listSynonymMapNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/synonymMaps/listSynonymMapNames.ts -[listSynonymMaps]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search/samples/typescript/src/synonymMaps/listSynonymMaps.ts +[createDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/dataSourceConnections/createDataSourceConnection.ts +[createOrUpdateDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/dataSourceConnections/createOrUpdateDataSourceConnection.ts +[deleteDataSourceConnectionByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/dataSourceConnections/deleteDataSourceConnectionByName.ts +[deleteDataSourceConnectionByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/dataSourceConnections/deleteDataSourceConnectionByObject.ts +[getDataSourceConnection]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/dataSourceConnections/getDataSourceConnection.ts +[listDataSourceConnectionNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/dataSourceConnections/listDataSourceConnectionNames.ts +[listDataSourceConnections]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/dataSourceConnections/listDataSourceConnections.ts +[createIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/createIndexer.ts +[createOrUpdateIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/createOrUpdateIndexer.ts +[deleteIndexerByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/deleteIndexerByName.ts +[deleteIndexerByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/deleteIndexerByObject.ts +[getIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/getIndexer.ts +[getIndexerStatus]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/getIndexerStatus.ts +[listIndexerNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/listIndexerNames.ts +[listIndexers]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/listIndexers.ts +[resetIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/resetIndexer.ts +[runIndexer]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexers/runIndexer.ts +[analyzeText]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/analyzeText.ts +[createIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/createIndex.ts +[createOrUpdateIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/createOrUpdateIndex.ts +[deleteIndexByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/deleteIndexByName.ts +[deleteIndexByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/deleteIndexByObject.ts +[getIndex]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/getIndex.ts +[getIndexStatistics]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/getIndexStatistics.ts +[listIndexes]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/listIndexes.ts +[listIndexNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/indexes/listIndexNames.ts +[createOrUpdateSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/skillSets/createOrUpdateSkillset.ts +[createSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/skillSets/createSkillset.ts +[deleteSkillsetByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/skillSets/deleteSkillsetByName.ts +[deleteSkillsetByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/skillSets/deleteSkillsetByObject.ts +[getSkillset]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/skillSets/getSkillset.ts +[listSkillsets]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/skillSets/listSkillsets.ts +[listSkillsetsNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/skillSets/listSkillsetsNames.ts +[createOrUpdateSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/synonymMaps/createOrUpdateSynonymMap.ts +[createSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/synonymMaps/createSynonymMap.ts +[deleteSynonymMapByName]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/synonymMaps/deleteSynonymMapByName.ts +[deleteSynonymMapByObject]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/synonymMaps/deleteSynonymMapByObject.ts +[getSynonymMap]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/synonymMaps/getSynonymMap.ts +[listSynonymMapNames]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/synonymMaps/listSynonymMapNames.ts +[listSynonymMaps]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/search/search-documents/samples/typescript/src/synonymMaps/listSynonymMaps.ts diff --git a/sdk/servicebus/service-bus/CHANGELOG.md b/sdk/servicebus/service-bus/CHANGELOG.md index 63509b04dfcb..5fe6b542682e 100644 --- a/sdk/servicebus/service-bus/CHANGELOG.md +++ b/sdk/servicebus/service-bus/CHANGELOG.md @@ -183,7 +183,7 @@ ## 1.0.0-preview.3 (2019-04-24) -- Proxy support added. Please refer to the [useProxy](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/servicebus/service-bus/samples/javascript/gettingStarted/useProxy.js) +- Proxy support added. Please refer to the [useProxy](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/servicebus/service-bus/samples/javascript/useProxy.js) sample to see how you can use Websockets to run this library with a proxy server - Standardized error messages on errors thrown on parameter validations - We now have API reference docs published for this library. Checkout our README which has been updated with the relevant API reference links. diff --git a/sdk/storage/README.md b/sdk/storage/README.md index ce4c80bb5583..a24aae413ef0 100644 --- a/sdk/storage/README.md +++ b/sdk/storage/README.md @@ -13,7 +13,7 @@ This project provides client libraries in JavaScript that makes it easy to consu - @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) +- [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/) ## Key concepts diff --git a/sdk/storage/storage-blob-changefeed/samples/typscript/basic.ts b/sdk/storage/storage-blob-changefeed/samples/typescript/basic.ts similarity index 100% rename from sdk/storage/storage-blob-changefeed/samples/typscript/basic.ts rename to sdk/storage/storage-blob-changefeed/samples/typescript/basic.ts diff --git a/sdk/storage/storage-blob-changefeed/samples/typscript/package.json b/sdk/storage/storage-blob-changefeed/samples/typescript/package.json similarity index 100% rename from sdk/storage/storage-blob-changefeed/samples/typscript/package.json rename to sdk/storage/storage-blob-changefeed/samples/typescript/package.json diff --git a/sdk/storage/storage-blob-changefeed/samples/typscript/resume.ts b/sdk/storage/storage-blob-changefeed/samples/typescript/resume.ts similarity index 100% rename from sdk/storage/storage-blob-changefeed/samples/typscript/resume.ts rename to sdk/storage/storage-blob-changefeed/samples/typescript/resume.ts diff --git a/sdk/storage/storage-blob-changefeed/samples/typscript/sample.env b/sdk/storage/storage-blob-changefeed/samples/typescript/sample.env similarity index 100% rename from sdk/storage/storage-blob-changefeed/samples/typscript/sample.env rename to sdk/storage/storage-blob-changefeed/samples/typescript/sample.env diff --git a/sdk/storage/storage-blob/CHANGELOG.md b/sdk/storage/storage-blob/CHANGELOG.md index 8c44c82076d3..7a839a0eb6c8 100644 --- a/sdk/storage/storage-blob/CHANGELOG.md +++ b/sdk/storage/storage-blob/CHANGELOG.md @@ -216,7 +216,7 @@ - Updated HTTP client from axios to node-fetch in Node.js runtime. - 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-blob/samples/typescript/proxyAuth.ts) +- 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) ## 12.0.0-preview.2 (2019.08) diff --git a/sdk/storage/storage-blob/README.md b/sdk/storage/storage-blob/README.md index 688fbcd9676b..01c0218c787b 100644 --- a/sdk/storage/storage-blob/README.md +++ b/sdk/storage/storage-blob/README.md @@ -13,7 +13,7 @@ Use the client libraries in this package to: [Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-blob) | [Package (npm)](https://www.npmjs.com/package/@azure/storage-blob/) | -[API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-blob) | +[API Reference Documentation](https://docs.microsoft.com/en-us/javascript/api/overview/azure/storage-overview) | [Product documentation](https://docs.microsoft.com/azure/storage/blobs/storage-blobs-overview) | [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-blob/samples) | [Azure Storage Blob REST APIs](https://docs.microsoft.com/rest/api/storageservices/blob-service-rest-api) @@ -39,7 +39,7 @@ Azure Storage supports several ways to authenticate. In order to interact with t #### Azure Active Directory -The Azure Blob Storage service supports the use of Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. Please see the [README for `@azure/identity`](/sdk/identity/identity/README.md) for more details and samples to get you started. +The Azure Blob Storage service supports the use of Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. Please see the [README for `@azure/identity`](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md) for more details and samples to get you started. ### Compatibility @@ -337,7 +337,7 @@ async function main() { main(); ``` -For a complete sample on iterating containers please see [samples/iterators-containers.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/iterators-containers.ts). +For a complete sample on iterating containers please see [samples/src/iterators-containers.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/src/iterators-containers.ts). ### Create a blob by uploading data to @@ -399,7 +399,7 @@ async function main() { main(); ``` -For a complete sample on iterating blobs please see [samples/iterators-blobs.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/iterators-blobs.ts). +For a complete sample on iterating blobs please see [samples/src/iterators-blobs.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/src/iterators-blobs.ts). ### Download a blob and convert it to a string (Node.js) @@ -491,7 +491,7 @@ async function main() { main(); ``` -A complete example of basic scenarios is at [samples/basic.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/basic.ts). +A complete example of basic scenarios is at [samples/src/basic.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/samples/typescript/src/basic.ts). ## Troubleshooting diff --git a/sdk/storage/storage-blob/samples/README.md b/sdk/storage/storage-blob/samples/README.md index c5b91156313b..d88848cd237f 100644 --- a/sdk/storage/storage-blob/samples/README.md +++ b/sdk/storage/storage-blob/samples/README.md @@ -27,7 +27,7 @@ Also, change `"../.."` to `"@azure/storage-blob"` in the samples in order to imp ### 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](./samples/azureAdAuth.ts). +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). ## Javascript sample diff --git a/sdk/storage/storage-file-datalake/README.md b/sdk/storage/storage-file-datalake/README.md index e857d9067cdd..db38c97655fb 100644 --- a/sdk/storage/storage-file-datalake/README.md +++ b/sdk/storage/storage-file-datalake/README.md @@ -37,7 +37,7 @@ Azure Storage supports several ways to authenticate. In order to interact with t #### Azure Active Directory -The Azure Data Lake Storage service supports the use of Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. Please see the [README for `@azure/identity`](/sdk/identity/identity/README.md) for more details and samples to get you started. +The Azure Data Lake Storage service supports the use of Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. Please see the [README for `@azure/identity`](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md) for more details and samples to get you started. ### Compatibility diff --git a/sdk/storage/storage-file-share/CHANGELOG.md b/sdk/storage/storage-file-share/CHANGELOG.md index 229cdfb6c1c4..75599ef9b025 100644 --- a/sdk/storage/storage-file-share/CHANGELOG.md +++ b/sdk/storage/storage-file-share/CHANGELOG.md @@ -149,7 +149,7 @@ - Added `DirectoryClient.listHandlesSegment()` and `FileClient.listHandlesSegment()` to returns a list of open handles on a directory or a file. - 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/proxyAuth.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/samples/typescript/proxyAuth.ts) +- 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) ## 12.0.0-preview.2 (2019.08) diff --git a/sdk/storage/storage-file-share/README.md b/sdk/storage/storage-file-share/README.md index ccb4581d07b5..c3b49988661a 100644 --- a/sdk/storage/storage-file-share/README.md +++ b/sdk/storage/storage-file-share/README.md @@ -374,7 +374,7 @@ async function main() { main(); ``` -For a complete sample on iterating please see [samples/iterators-files-and-directories.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/samples/typescript/iterators-files-and-directories.ts). +For a complete sample on iterating please see [samples/typescript/src/iterators-files-and-directories.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/samples/typescript/src/iterators-files-and-directories.ts). ### Download a file and convert it to a string (Node.js) @@ -469,7 +469,7 @@ async function blobToString(blob) { main() ``` -A complete example of basic scenarios is at [samples/basic.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/samples/typescript/basic.ts). +A complete example of basic scenarios is at [samples/typescript/src/basic.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/samples/typescript/src/basic.ts). ## Troubleshooting diff --git a/sdk/storage/storage-queue/CHANGELOG.md b/sdk/storage/storage-queue/CHANGELOG.md index 02039fbe2975..3ef29899d9b7 100644 --- a/sdk/storage/storage-queue/CHANGELOG.md +++ b/sdk/storage/storage-queue/CHANGELOG.md @@ -131,7 +131,7 @@ - Updated HTTP client from axios to node-fetch in Node.js runtime. - 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/proxyAuth.ts) +- 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) ## 12.0.0-preview.2 (2019.08) diff --git a/sdk/storage/storage-queue/README.md b/sdk/storage/storage-queue/README.md index 107768cf02e1..ee3756164bdf 100644 --- a/sdk/storage/storage-queue/README.md +++ b/sdk/storage/storage-queue/README.md @@ -38,7 +38,7 @@ Azure Storage supports several ways to authenticate. In order to interact with t #### Azure Active Directory -The Azure Queue Storage service supports the use of Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. Please see the [README for `@azure/identity`](/sdk/identity/identity/README.md) for more details and samples to get you started. +The Azure Queue Storage service supports the use of Azure Active Directory to authenticate requests to its APIs. The [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) package provides a variety of credential types that your application can use to do this. Please see the [README for `@azure/identity`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity/README.md) for more details and samples to get you started. ### Compatibility @@ -263,7 +263,7 @@ async function main() { main(); ``` -For a complete sample on iterating queues please see [samples/typescript/iterators.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/samples/typescript/iterators.ts). +For a complete sample on iterating queues please see [samples/typescript/iterators.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/samples/typescript/src/iterators.ts). ### Create a new queue @@ -421,7 +421,7 @@ async function main() { main(); ``` -A complete example of basic scenarios is at [samples/basic.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/samples/typescript/basic.ts). +A complete example of basic scenarios is at [samples/basic.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/samples/typescript/src/basic.ts). ## Troubleshooting