diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 057ab8c913b1..b14a489d3bc0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,7 +113,7 @@ Mypy install and run. ### More Reading -We maintain an [additional document](doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions. +We maintain an [additional document](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions. ### Dev Feed Daily dev build version of Azure sdk packages for python are available and are uploaded to Azure devops feed daily. We have also created a tox environment to test a package against dev built version of dependent packages. Below is the link to Azure devops feed. diff --git a/README.md b/README.md index 3f390f79ffa8..692b288b3363 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Each service might have a number of libraries available from each of the followi ### Client: New Releases -New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries allow you to use and consume existing resources and interact with them, for example: upload a blob. These libraries share a number of core functionalities such as: retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure-core](./sdk/core/azure-core) library. You can learn more about these libraries by reading guidelines that they follow [here](https://azure.github.io/azure-sdk/python_introduction.html). +New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries allow you to use and consume existing resources and interact with them, for example: upload a blob. These libraries share a number of core functionalities such as: retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure-core](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core) library. You can learn more about these libraries by reading guidelines that they follow [here](https://azure.github.io/azure-sdk/python_introduction.html). You can find the [most up to date list of all of the new packages on our page](https://azure.github.io/azure-sdk/releases/latest/index.html#python-packages) @@ -60,7 +60,7 @@ Security issues and bugs should be reported privately, via email, to the Microso ## Contributing -For details on contributing to this repository, see the [contributing guide](CONTRIBUTING.md). +For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/master/CONTRIBUTING.md). This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. diff --git a/doc/README.md b/doc/README.md index b4ecf81e6fd9..236b1b83b742 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,7 +1,7 @@ This folder contains some documentations for this repository: The folder structure is the following -- [sphinx](./sphinx) : contains the documentation source code for https://azure.github.io/azure-sdk-for-python/ -- [dev](./dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK) +- [sphinx](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/sphinx) : contains the documentation source code for https://azure.github.io/azure-sdk-for-python/ +- [dev](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK) -The file [eng_sys_checks](eng_sys_checks.md) is a read up as to what a standard `ci.yml` will actually execute. \ No newline at end of file +The file [eng_sys_checks](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/eng_sys_checks.md) is a read up as to what a standard `ci.yml` will actually execute. diff --git a/doc/dev/README.md b/doc/dev/README.md index 9afddd10aa13..dcd202bd93d3 100644 --- a/doc/dev/README.md +++ b/doc/dev/README.md @@ -3,8 +3,8 @@ This folder contains documentation for developers of SDK: internal teams at Microsoft, or advanced contributors. Overview of the documents: -- [dev setup](./dev_setup.md) : How to create a development environment for this repo -- [release](./release.md) : How to release a package when ready -- [packaging.md](./packaging.md) : How to organize packaging information for packages under `azure` +- [dev setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) : How to create a development environment for this repo +- [release](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/release.md) : How to release a package when ready +- [packaging.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/packaging.md) : How to organize packaging information for packages under `azure` -The [mgmt](./mgmt) folder contains information specific to management packages (i.e. packages prefixed by `azure-mgmt`) \ No newline at end of file +The [mgmt](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt) folder contains information specific to management packages (i.e. packages prefixed by `azure-mgmt`) diff --git a/doc/dev/mgmt/README.md b/doc/dev/mgmt/README.md index bd7c129c274c..34a1bfb2bfb2 100644 --- a/doc/dev/mgmt/README.md +++ b/doc/dev/mgmt/README.md @@ -2,13 +2,13 @@ The documentation in that folder is intended for developers at Microsoft, or for advanced contributors, in the ARM (Azure Resource Management) world. -The [cheat sheet](./cheatsheet.md) page contains a quick reminder of the basic commands if you are already familiar with this repo. +The [cheat sheet](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/cheatsheet.md) page contains a quick reminder of the basic commands if you are already familiar with this repo. In order of workflow: -- [swagger_conf.md](./swagger_conf.md) : Describe how to configure the different Readme on https://github.com/Azure/azure-rest-api-specs for Python -- [tests.md](./tests.md) : How to test management SDK (recordings, etc.) -- [mgmt_release.md](./mgmt_release.md) : How to finish preapring the package, changelog, version, etc. +- [swagger_conf.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md) : Describe how to configure the different Readme on https://github.com/Azure/azure-rest-api-specs for Python +- [tests.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/tests.md) : How to test management SDK (recordings, etc.) +- [mgmt_release.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/mgmt_release.md) : How to finish preapring the package, changelog, version, etc. More implementations / advanced documents: -- [changelog_impl.md](./changelog_impl.md) : Technical details about the change log tool implementation +- [changelog_impl.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/changelog_impl.md) : Technical details about the change log tool implementation diff --git a/doc/dev/mgmt/generation.md b/doc/dev/mgmt/generation.md index f5fec80c2d02..84fbab3b8dad 100644 --- a/doc/dev/mgmt/generation.md +++ b/doc/dev/mgmt/generation.md @@ -1,8 +1,8 @@ # Generation of SDK -Assuming your Swagger are associated with correct Readmes (otherwise see previous chapter [Swagger conf](./swagger_conf.md)), this page explains how to generate your packages. +Assuming your Swagger are associated with correct Readmes (otherwise see previous chapter [Swagger conf](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md)), this page explains how to generate your packages. -IMPORTANT NOTE: All the commands prefixed by `python` in this page assumes you have loaded the [dev_setup](../dev_setup.md) in your currently loaded virtual environment. +IMPORTANT NOTE: All the commands prefixed by `python` in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment. ## Building the code diff --git a/doc/dev/mgmt/mgmt_release.md b/doc/dev/mgmt/mgmt_release.md index bce50207768a..abefe8dc583e 100644 --- a/doc/dev/mgmt/mgmt_release.md +++ b/doc/dev/mgmt/mgmt_release.md @@ -16,7 +16,7 @@ Once Swagger PR is merged, SDK automation will create pull request to Azure SDK Once you have a PR that contains accurate with correct tests (or no tests at all, but CI is green), this page explains how to prepare for a release. -IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](../dev_setup.md) in your currently loaded virtual environment. +IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment. ## Manual generation @@ -158,4 +158,4 @@ Python SDK _strictly_ follows [semver](https://semver.org/). A few notes: - Next stable breaking is 3.0.0 - Next preview feature is 2.2.0rc1 - Next stable feature is 2.2.0 - - Next patch is 2.1.1 \ No newline at end of file + - Next patch is 2.1.1 diff --git a/doc/dev/mgmt/multiapi.md b/doc/dev/mgmt/multiapi.md index dfe608047703..1fd0127e3bb3 100644 --- a/doc/dev/mgmt/multiapi.md +++ b/doc/dev/mgmt/multiapi.md @@ -44,7 +44,7 @@ Network interfaces operations are defines in a [network interface file](https:// **Python multi-api packaging is based on the assumptions that it's true.** If it's not, it's usually ok but requires a little more subtle packaging (see final section here) -Being that a given Swagger defines only *one* fixed API version, doing multi-api version in one package implies shipping several Swagger files into one package. This is archived by the `batch` directive of Autorest. More details on how to write Readme for Swagger in the specific page for it [swagger_conf.md](./swagger_conf.md). +Being that a given Swagger defines only *one* fixed API version, doing multi-api version in one package implies shipping several Swagger files into one package. This is archived by the `batch` directive of Autorest. More details on how to write Readme for Swagger in the specific page for it [swagger_conf.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md). Python SDK team is responsible to design the correct set of tags to set for the `batch` node. Each line of the batch directive should contains only *one* api version to match the folder name used. this might require adding new tags in the readme.md that are specific to only one API version. These tags are usually suffixed by "-only" ([example with compute](https://github.com/Azure/azure-rest-api-specs/tree/master/specification/compute/resource-manager#tag-package-2019-03-01-only)) @@ -119,4 +119,4 @@ If this is not the same API version, then we need to bend the rules a little: we Current implementation assumes operation group are unique, and as discussed it's not always the case. Also, this limitation has impact on intellisense right now. Example, if a user types `compute_client.virtual_machines.` and hit the intellisense shortcut, users won't see any suggestions. It's because the `virtual_machines` property is dynamic and can change depending of dynamic configuration. -To improve intellisense and allow operation level profile, the concept would be to make the [operation mixin multi-api concept](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/network/azure-mgmt-network/azure/mgmt/network/_operations_mixin.py) applicable to operation groups as well. I estimate this work to a week of dev-ish. \ No newline at end of file +To improve intellisense and allow operation level profile, the concept would be to make the [operation mixin multi-api concept](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/network/azure-mgmt-network/azure/mgmt/network/_operations_mixin.py) applicable to operation groups as well. I estimate this work to a week of dev-ish. diff --git a/doc/dev/mgmt/swagger/single_api/readme.md b/doc/dev/mgmt/swagger/single_api/readme.md index 233f19b4173e..60c976840890 100644 --- a/doc/dev/mgmt/swagger/single_api/readme.md +++ b/doc/dev/mgmt/swagger/single_api/readme.md @@ -66,4 +66,4 @@ swagger-to-sdk: ## Python -See configuration in [readme.python.md](./readme.python.md) +See configuration in [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/single_api/readme.python.md) diff --git a/doc/dev/mgmt/swagger_conf.md b/doc/dev/mgmt/swagger_conf.md index b026757b1306..a91ec28f8aac 100644 --- a/doc/dev/mgmt/swagger_conf.md +++ b/doc/dev/mgmt/swagger_conf.md @@ -10,7 +10,7 @@ Nowadays, swagger files are actually not the input for Autorest, the input is _r autorest readme.md --python ``` -In practical terms, we want to control the version of Autorest used, the output folder, etc. but this article will focus on Swagger and Readme. For more details about generation, see the [generation page](./generation.md). +In practical terms, we want to control the version of Autorest used, the output folder, etc. but this article will focus on Swagger and Readme. For more details about generation, see the [generation page](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/generation.md). ## Writing the readme diff --git a/doc/dev/mgmt/tests.md b/doc/dev/mgmt/tests.md index 5ec93aedec80..bf95279d0fff 100644 --- a/doc/dev/mgmt/tests.md +++ b/doc/dev/mgmt/tests.md @@ -11,7 +11,7 @@ - [Running tests in live mode](#running-tests-in-live-mode) - [Using the Azure Python SDK test framework](#using-the-azure-python-sdk-test-framework) -IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](../dev_setup.md) in your currently loaded virtual environment. +IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment. # Overview diff --git a/doc/eng_sys_checks.md b/doc/eng_sys_checks.md index 81d8e861af2d..a7927da3dce5 100644 --- a/doc/eng_sys_checks.md +++ b/doc/eng_sys_checks.md @@ -2,7 +2,7 @@ There are various tests currently enabled in Azure pipeline for Python SDK and some of them are enabled only for nightly CI checks. We also run some static analysis tool to verify code completeness, security and lint check. -Check the [contributing guide](../CONTRIBUTING.md#building-and-testing) for an intro to `tox`. +Check the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/master/CONTRIBUTING.md#building-and-testing) for an intro to `tox`. As a contributor, you will see the build jobs run in two modes: `Nightly Scheduled` and `Pull Request`. @@ -45,7 +45,7 @@ Analyze job in both nightly CI and pull request validation pipeline runs a set o #### Change log verification -Change log verification is added to ensure package has valid change log for current version. Guidelines to properly maintain the change log is documented [here]() +Change log verification is added to ensure package has valid change log for current version. Guidelines to properly maintain the change log is documented [here](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/) ## PR Validation Checks Each pull request runs various tests using `pytest` in addition to all the tests mentioned above in analyze check. Pull request validation performs 3 different types of test: `whl, sdist and depends`. Following section explains the purpose of each of these tests and how to execute them locally. All pull requests are validated on multiple python versions across different platforms and below is the test matrix for pull request. diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index 2a0f63a811d8..aaefeb212243 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -73,6 +73,7 @@ jobs: - template: ../../../common/pipelines/templates/steps/verify-links.yml parameters: Directory: "sdk/${{ parameters.ServiceDirectory }}" + CheckLinkGuidance: $true - template: ../steps/analyze.yml parameters: diff --git a/eng/pipelines/templates/steps/build-artifacts.yml b/eng/pipelines/templates/steps/build-artifacts.yml index 23419302a11f..8550d1567db7 100644 --- a/eng/pipelines/templates/steps/build-artifacts.yml +++ b/eng/pipelines/templates/steps/build-artifacts.yml @@ -18,13 +18,6 @@ steps: - script: | pip install -r eng/ci_tools.txt displayName: 'Prep Py2 Environment' - - - template: /eng/common/pipelines/templates/steps/replace-relative-links.yml - parameters: - TargetFolder: $(Build.SourcesDirectory) - RootFolder: $(Build.SourcesDirectory) - BuildSHA: $(Build.SourceVersion) - RepoId: 'Azure/azure-sdk-for-python' - task: PythonScript@0 displayName: 'Generate Python2 Applicable Namespace Packages' diff --git a/sdk/anomalydetector/azure-ai-anomalydetector/samples/README.md b/sdk/anomalydetector/azure-ai-anomalydetector/samples/README.md index d3cbeb03df82..494febf52dcf 100644 --- a/sdk/anomalydetector/azure-ai-anomalydetector/samples/README.md +++ b/sdk/anomalydetector/azure-ai-anomalydetector/samples/README.md @@ -54,6 +54,6 @@ what you can do with the Azure Anomaly Detector client library. [azure_anomaly_detector_account]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesAnomalyDetector [python-fr-ref-docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-cognitiveservices-anomalydetector/0.3.0/index.html -[sample_detect_entire_series_anomaly]: ./sample_detect_entire_series_anomaly.py -[sample_detect_last_point_anomaly]: ./sample_detect_last_point_anomaly.py -[sample_detect_change_point]: ./sample_detect_change_point.py +[sample_detect_entire_series_anomaly]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/anomalydetector/azure-ai-anomalydetector/samples/sample_detect_entire_series_anomaly.py +[sample_detect_last_point_anomaly]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/anomalydetector/azure-ai-anomalydetector/samples/sample_detect_last_point_anomaly.py +[sample_detect_change_point]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/anomalydetector/azure-ai-anomalydetector/samples/sample_detect_change_point.py diff --git a/sdk/appconfiguration/azure-appconfiguration/README.md b/sdk/appconfiguration/azure-appconfiguration/README.md index 6a243e12d753..e8a25c311973 100644 --- a/sdk/appconfiguration/azure-appconfiguration/README.md +++ b/sdk/appconfiguration/azure-appconfiguration/README.md @@ -6,7 +6,7 @@ Modern programs, especially programs running in a cloud, generally have many com Use the client library for App Configuration to create and manage application configuration settings. -[Source code]() | [Package (Pypi)][package] | [API reference documentation]() | [Product documentation][appconfig_docs] +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/appconfiguration/azure-appconfiguration) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/appconfiguration/azure-appconfiguration) | [Product documentation][appconfig_docs] ## Getting started diff --git a/sdk/core/azure-core/README.md b/sdk/core/azure-core/README.md index 774a84d8d0c0..7ca78862fefa 100644 --- a/sdk/core/azure-core/README.md +++ b/sdk/core/azure-core/README.md @@ -6,7 +6,7 @@ These libraries follow the [Azure SDK Design Guidelines for Python](https://azur If you are a client library developer, please reference [client library developer reference](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md) for more information. -[Source code]() | [Package (Pypi)][package] | [API reference documentation]() +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/) ## Getting started diff --git a/sdk/core/azure-mgmt-core/README.md b/sdk/core/azure-mgmt-core/README.md index bbcb6d5993bd..58c243e4302c 100644 --- a/sdk/core/azure-mgmt-core/README.md +++ b/sdk/core/azure-mgmt-core/README.md @@ -5,7 +5,7 @@ Azure management core library defines extensions to Azure Core that are specific As an end user, you don't need to manually install azure-mgmt-core because it will be installed automatically when you install other SDKs. -[Source code]() | [Package (Pypi)][package] | [API reference documentation]() +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-mgmt-core/) | [Package (Pypi)][package] | [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-mgmt-core/) ## Contributing diff --git a/sdk/cosmos/README.md b/sdk/cosmos/README.md index f6cd10f7be07..1f0eff7d0b0d 100644 --- a/sdk/cosmos/README.md +++ b/sdk/cosmos/README.md @@ -6,7 +6,7 @@ Use the Azure Cosmos DB SQL API SDKs for application development and database ma ## Contents of this folder -### [azure-cosmos](./azure-cosmos) +### [azure-cosmos](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/cosmos/azure-cosmos) This is the Azure Cosmos DB SQL API SDK for Python to manage databases and the JSON documents they contain in this NoSQL database service. High level capabilities are: @@ -17,7 +17,7 @@ This is the Azure Cosmos DB SQL API SDK for Python to manage databases and the J Use this package if you are creating an application or exploring data. -### [azure-mgmt-cosmosdb](./azure-mgmt-cosmosdb) +### [azure-mgmt-cosmosdb](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/cosmos/azure-mgmt-cosmosdb) This is the Microsoft Azure Cosmos DB Management Client Library. High level capabilities are: @@ -34,7 +34,7 @@ This is the Microsoft Azure Cosmos DB Management Client Library. High level capa Use this package if you are creating an account level management application. -### [azure-mgmt-documentdb](./azure-mgmt-documentdb) +### [azure-mgmt-documentdb](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/cosmos/azure-mgmt-documentdb) Legacy DocumentDB SDK. diff --git a/sdk/cosmos/azure-cosmos/README.md b/sdk/cosmos/azure-cosmos/README.md index cbe4a8ae2651..a4a9100fe1d2 100644 --- a/sdk/cosmos/azure-cosmos/README.md +++ b/sdk/cosmos/azure-cosmos/README.md @@ -11,7 +11,7 @@ Use the Azure Cosmos DB SQL API SDK for Python to manage databases and the JSON [SDK source code][source_code] | [Package (PyPI)][cosmos_pypi] | [API reference documentation][ref_cosmos_sdk] | [Product documentation][cosmos_docs] | [Samples][cosmos_samples] -> This SDK is used for the [SQL API](https://docs.microsoft.com/en-us/azure/cosmos-db/sql-query-getting-started). For all other APIs, please check the [Azure Cosmos DB documentation](https://docs.microsoft.com/en-us/azure/cosmos-db/introduction) to evaluate the best SDK for your project. +> This SDK is used for the [SQL API](https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started). For all other APIs, please check the [Azure Cosmos DB documentation](https://docs.microsoft.com/azure/cosmos-db/introduction) to evaluate the best SDK for your project. ## Getting started @@ -92,7 +92,7 @@ As of August 2020 the features below are not yet supported. ## Limitations Workaround -If you want to use Python SDK to perform bulk inserts to Cosmos DB, the best alternative is to use [stored procedures](https://docs.microsoft.com/en-us/azure/cosmos-db/how-to-write-stored-procedures-triggers-udfs) to write multiple items with the same partition key. +If you want to use Python SDK to perform bulk inserts to Cosmos DB, the best alternative is to use [stored procedures](https://docs.microsoft.com/azure/cosmos-db/how-to-write-stored-procedures-triggers-udfs) to write multiple items with the same partition key. ## Examples @@ -151,7 +151,7 @@ except exceptions.CosmosHttpResponseError: ### Create an analytical store enabled container -This example creates a container with [Analytical Store](https://docs.microsoft.com/en-us/azure/cosmos-db/analytical-store-introduction) enabled, for reporting, BI, AI, and Advanced Analytics with [Azure Synapse Link](https://docs.microsoft.com/en-us/azure/cosmos-db/synapse-link). +This example creates a container with [Analytical Store](https://docs.microsoft.com/azure/cosmos-db/analytical-store-introduction) enabled, for reporting, BI, AI, and Advanced Analytics with [Azure Synapse Link](https://docs.microsoft.com/azure/cosmos-db/synapse-link). The options for analytical_storage_ttl are: diff --git a/sdk/eventgrid/azure-eventgrid/README.md b/sdk/eventgrid/azure-eventgrid/README.md index ec7816e8e918..7ee2a682c11b 100644 --- a/sdk/eventgrid/azure-eventgrid/README.md +++ b/sdk/eventgrid/azure-eventgrid/README.md @@ -219,7 +219,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [python-eg-src]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/ [python-eg-pypi]: https://pypi.org/project/azure-eventgrid -[python-eg-product-docs]: https://docs.microsoft.com/en-us/azure/event-grid/overview +[python-eg-product-docs]: https://docs.microsoft.com/azure/event-grid/overview [python-eg-ref-docs]: https://aka.ms/azsdk/python/eventgrid/docs [python-eg-samples]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventgrid/azure-eventgrid/samples [python-eg-changelog]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventgrid/azure-eventgrid/CHANGELOG.md @@ -237,7 +237,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [python-eg-sample-consume-customevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs4_consume_custom_events.py [python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs5_publish_events_using_cloud_events_1.0_schema.py [python-eg-sample-consume-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs6_consume_events_using_cloud_events_1.0_schema.py -[publisher-service-doc]: https://docs.microsoft.com/en-us/azure/event-grid/concepts +[publisher-service-doc]: https://docs.microsoft.com/azure/event-grid/concepts [cla]: https://cla.microsoft.com [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ diff --git a/sdk/eventgrid/azure-eventgrid/samples/README.md b/sdk/eventgrid/azure-eventgrid/samples/README.md index c9e5555bf368..e59be381038a 100644 --- a/sdk/eventgrid/azure-eventgrid/samples/README.md +++ b/sdk/eventgrid/azure-eventgrid/samples/README.md @@ -25,4 +25,4 @@ These code samples show common champion scenario operations with the Azure Event [python-eg-sample-consume-customevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs4_consume_custom_events.py [python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs5_publish_events_using_cloud_events_1.0_schema.py [python-eg-sample-consume-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs6_consume_events_using_cloud_events_1.0_schema.py -[publisher-service-doc]: https://docs.microsoft.com/en-us/azure/event-grid/concepts \ No newline at end of file +[publisher-service-doc]: https://docs.microsoft.com/azure/event-grid/concepts diff --git a/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/README.md b/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/README.md index 326ffa1d824d..7a2fb134cd0c 100644 --- a/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/README.md +++ b/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/README.md @@ -3,9 +3,9 @@ Azure EventHubs Checkpoint Store is used for storing checkpoints while processing events from Azure Event Hubs. This Checkpoint Store package works as a plug-in package to `EventHubConsumerClient`. It uses Azure Storage Blob as the persistent store for maintaining checkpoints and partition ownership information. -Please note that this is an async library, for sync version of the Azure EventHubs Checkpoint Store client library, please refer to [azure-eventhub-checkpointstoreblob](../azure-eventhub-checkpointstoreblob). +Please note that this is an async library, for sync version of the Azure EventHubs Checkpoint Store client library, please refer to [azure-eventhub-checkpointstoreblob](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob). -[Source code](./) | [Package (PyPi)](https://pypi.org/project/azure-eventhub-checkpointstoreblob-aio/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.aio.html#azure.eventhub.aio.CheckpointStore) | [Azure Eventhubs documentation](https://docs.microsoft.com/azure/event-hubs/) | [Azure Storage documentation](https://docs.microsoft.com/azure/storage/) +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/) | [Package (PyPi)](https://pypi.org/project/azure-eventhub-checkpointstoreblob-aio/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.aio.html#azure.eventhub.aio.CheckpointStore) | [Azure Eventhubs documentation](https://docs.microsoft.com/azure/event-hubs/) | [Azure Storage documentation](https://docs.microsoft.com/azure/storage/) ## Getting started @@ -57,7 +57,7 @@ The easiest way to create a `EventHubConsumerClient` is to use a connection stri from azure.eventhub.aio import EventHubConsumerClient eventhub_client = EventHubConsumerClient.from_connection_string("my_eventhub_namespace_connection_string", "my_consumer_group", eventhub_name="my_eventhub") ``` -For other ways of creating a `EventHubConsumerClient`, refer to [EventHubs library](../azure-eventhub) for more details. +For other ways of creating a `EventHubConsumerClient`, refer to [EventHubs library](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub) for more details. ### Consume events using a `BlobCheckpointStore` to do checkpoint ```python @@ -118,8 +118,8 @@ Enabling logging will be helpful to do trouble shooting. ## Next steps ### Examples -- [./samples/receive_events_using_checkpoint_store_async.py](./samples/receive_events_using_checkpoint_store_async.py) - EventHubConsumerClient with blob checkpoint store example -- [./samples/receive_events_using_checkpoint_store_storage_api_version_async.py](./samples/receive_events_using_checkpoint_store_storage_api_version_async.py) - EventHubConsumerClient with blob checkpoint store and storage version example +- [https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/samples/receive_events_using_checkpoint_store_async.py](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/samples/receive_events_using_checkpoint_store_async.py) - EventHubConsumerClient with blob checkpoint store example +- [https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/samples/receive_events_using_checkpoint_store_storage_api_version_async.py](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio/samples/receive_events_using_checkpoint_store_storage_api_version_async.py) - EventHubConsumerClient with blob checkpoint store and storage version example ### Documentation diff --git a/sdk/eventhub/azure-eventhub-checkpointstoreblob/README.md b/sdk/eventhub/azure-eventhub-checkpointstoreblob/README.md index 55a283b38be1..dba40e1b5234 100644 --- a/sdk/eventhub/azure-eventhub-checkpointstoreblob/README.md +++ b/sdk/eventhub/azure-eventhub-checkpointstoreblob/README.md @@ -3,9 +3,9 @@ Azure EventHubs Checkpoint Store is used for storing checkpoints while processing events from Azure Event Hubs. This Checkpoint Store package works as a plug-in package to `EventHubConsumerClient`. It uses Azure Storage Blob as the persistent store for maintaining checkpoints and partition ownership information. -Please note that this is a sync library, for async version of the Azure EventHubs Checkpoint Store client library, please refer to [azure-eventhub-checkpointstoreblob-aio](../azure-eventhub-checkpointstoreblob-aio). +Please note that this is a sync library, for async version of the Azure EventHubs Checkpoint Store client library, please refer to [azure-eventhub-checkpointstoreblob-aio](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio). -[Source code](./) | [Package (PyPi)](https://pypi.org/project/azure-eventhub-checkpointstoreblob) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html#azure.eventhub.CheckpointStore) | [Azure Eventhubs documentation](https://docs.microsoft.com/azure/event-hubs/) | [Azure Storage documentation](https://docs.microsoft.com/azure/storage/) +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob/) | [Package (PyPi)](https://pypi.org/project/azure-eventhub-checkpointstoreblob) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html#azure.eventhub.CheckpointStore) | [Azure Eventhubs documentation](https://docs.microsoft.com/azure/event-hubs/) | [Azure Storage documentation](https://docs.microsoft.com/azure/storage/) ## Getting started @@ -57,7 +57,7 @@ The easiest way to create a `EventHubConsumerClient` is to use a connection stri from azure.eventhub import EventHubConsumerClient eventhub_client = EventHubConsumerClient.from_connection_string("my_eventhub_namespace_connection_string", "my_consumer_group", eventhub_name="my_eventhub") ``` -For other ways of creating a `EventHubConsumerClient`, refer to [EventHubs library](../azure-eventhub) for more details. +For other ways of creating a `EventHubConsumerClient`, refer to [EventHubs library](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub) for more details. ### Consume events using a `BlobCheckpointStore` to do checkpoint ```python @@ -117,8 +117,8 @@ Enabling logging will be helpful to do trouble shooting. ## Next steps ### Examples -- [./samples/receive_events_using_checkpoint_store.py](./samples/receive_events_using_checkpoint_store.py) - EventHubConsumerClient with blob checkpoint store example -- [./samples/receive_events_using_checkpoint_store_storage_api_version.py](./samples/receive_events_using_checkpoint_store_storage_api_version.py) - EventHubConsumerClient with blob checkpoint store and storage version example +- [https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob/samples/receive_events_using_checkpoint_store.py](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob/samples/receive_events_using_checkpoint_store.py) - EventHubConsumerClient with blob checkpoint store example +- [https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob/samples/receive_events_using_checkpoint_store_storage_api_version.py](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob/samples/receive_events_using_checkpoint_store_storage_api_version.py) - EventHubConsumerClient with blob checkpoint store and storage version example ### Documentation diff --git a/sdk/eventhub/azure-eventhub/README.md b/sdk/eventhub/azure-eventhub/README.md index 60a4f4184862..12c644e32658 100644 --- a/sdk/eventhub/azure-eventhub/README.md +++ b/sdk/eventhub/azure-eventhub/README.md @@ -13,7 +13,7 @@ The Azure Event Hubs client library allows for publishing and consuming of Azure - Observe interesting operations and interactions happening within your business or other ecosystem, allowing loosely coupled systems to interact without the need to bind them together. - Receive events from one or more publishers, transform them to better meet the needs of your ecosystem, then publish the transformed events to a new stream for consumers to observe. -[Source code](./) | [Package (PyPi)](https://pypi.org/project/azure-eventhub/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html) | [Product documentation](https://docs.microsoft.com/azure/event-hubs/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples) +[Source code](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/) | [Package (PyPi)](https://pypi.org/project/azure-eventhub/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-eventhub/latest/azure.eventhub.html) | [Product documentation](https://docs.microsoft.com/azure/event-hubs/) | [Samples](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/eventhub/azure-eventhub/samples) ## Getting started ### Prerequisites @@ -53,7 +53,7 @@ entity name to your Event Hub instance. You can get the connection string from t Alternately, one can use a Credential object to authenticate via AAD with the azure-identity package. - This constructor demonstrated in the sample linked above takes the host name and entity name of your Event Hub instance and credential that implements the -[TokenCredential](../../core/azure-core/azure/core/credentials.py) +[TokenCredential](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/azure/core/credentials.py) protocol. There are implementations of the `TokenCredential` protocol available in the [azure-identity package](https://pypi.org/project/azure-identity/). The host name is of the format ``. - When using Azure Active Directory, your principal must be assigned a role which allows access to Event Hubs, such as the @@ -319,8 +319,8 @@ In the below example, we create an instance of `EventHubConsumerClient` and use to [create an Azure Storage account](https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal) and a [Blob Container](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container) to run the code. -[Azure Blob Storage Checkpoint Store Async](../azure-eventhub-checkpointstoreblob-aio) -and [Azure Blob Storage Checkpoint Store Sync](../azure-eventhub-checkpointstoreblob) +[Azure Blob Storage Checkpoint Store Async](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob-aio) +and [Azure Blob Storage Checkpoint Store Sync](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub-checkpointstoreblob) are one of the `CheckpointStore` implementations we provide that applies Azure Blob Storage as the persistent store. @@ -382,7 +382,7 @@ client = EventHubConsumerClient.from_connection_string(connection_str, consumer_ partition_ids = client.get_partition_ids() ``` - Programmatically retrieve the built-in Event Hubs compatible endpoint. -Refer to [IoT Hub Connection String Sample](./samples/async_samples/iot_hub_connection_string_receive_async.py). +Refer to [IoT Hub Connection String Sample](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/samples/async_samples/iot_hub_connection_string_receive_async.py). ## Troubleshooting @@ -408,7 +408,7 @@ The Event Hubs APIs generate the following exceptions in azure.eventhub.exceptio ### More sample code -Please take a look at the [samples](./samples) directory for detailed examples of how to use this library to send and receive events to/from Event Hubs. +Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/samples) directory for detailed examples of how to use this library to send and receive events to/from Event Hubs. ### Documentation diff --git a/sdk/eventhub/azure-eventhub/migration_guide.md b/sdk/eventhub/azure-eventhub/migration_guide.md index 0c2b40b5302e..8a32f3b48808 100644 --- a/sdk/eventhub/azure-eventhub/migration_guide.md +++ b/sdk/eventhub/azure-eventhub/migration_guide.md @@ -30,9 +30,9 @@ The code samples in this migration guide use async APIs. | In v1 | Equivalent in v5 | Sample | |---|---|---| -| `EventHubClientAsync()` | `EventHubProducerClient()` or `EventHubConsumerClient()` | [using credential](./samples/async_samples/client_identity_authentication_async.py ) | -| `EventHubClientAsync.from_connection_string()` | `EventHubProducerClient.from_connection_string` or `EventHubConsumerClient.from_connection_string` |[client creation](./samples/async_samples/client_creation_async.py) | -| `EventProcessorHost()`| `EventHubConsumerClient(..., checkpoint_store)`| [receive events using checkpoint store](./samples/async_samples/recv_with_checkpoint_store_async.py) | +| `EventHubClientAsync()` | `EventHubProducerClient()` or `EventHubConsumerClient()` | [using credential](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/samples/async_samples/client_identity_authentication_async.py) | +| `EventHubClientAsync.from_connection_string()` | `EventHubProducerClient.from_connection_string` or `EventHubConsumerClient.from_connection_string` |[client creation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/samples/async_samples/client_creation_async.py) | +| `EventProcessorHost()`| `EventHubConsumerClient(..., checkpoint_store)`| [receive events using checkpoint store](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/samples/async_samples/recv_with_checkpoint_store_async.py) | In V5, the SDK provides `BlobCheckpointStore` in extension packages azure-eventhub-checkpointstoreblob (for sync) and azure-eventhub-checkpointstoreblob-aio (for async). You can define your own `CheckpointStore` class to persist checkpoint data. @@ -41,14 +41,14 @@ You can define your own `CheckpointStore` class to persist checkpoint data. | In v1 | Equivalent in v5 | Sample | |---|---|---| -| `EventHubClientAsync.add_async_receiver()` and `AsyncReceiver.receive()`| `EventHubConsumerClient.receive()`| [receive events](./samples/async_samples/recv_async.py) | +| `EventHubClientAsync.add_async_receiver()` and `AsyncReceiver.receive()`| `EventHubConsumerClient.receive()`| [receive events](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/samples/async_samples/recv_async.py) | ### Sending events The process of building event batches is more transparent with `send_batch` of V5. | In v1 | Equivalent in v5 | Sample | |---|---|---| -| `EventHubClientAsync.add_async_sender()` and `AsyncSender.send()`| `EventHubProducerClient.send_batch()`| [send events](./samples/async_samples/send_async.py) | +| `EventHubClientAsync.add_async_sender()` and `AsyncSender.send()`| `EventHubProducerClient.send_batch()`| [send events](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventhub/azure-eventhub/samples/async_samples/send_async.py) | ## Migration samples diff --git a/sdk/identity/azure-identity/samples/README.md b/sdk/identity/azure-identity/samples/README.md index 35a9cd502650..b2a2f99cce95 100644 --- a/sdk/identity/azure-identity/samples/README.md +++ b/sdk/identity/azure-identity/samples/README.md @@ -13,10 +13,10 @@ urlFragment: identity-samples ## Prerequisites You must have an [Azure subscription](https://azure.microsoft.com/free) and an -[Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/) to run +[Azure Key Vault](https://azure.microsoft.com/services/key-vault/) to run these samples. You can create a Key Vault in the [Azure Portal](https://portal.azure.com/#create/Microsoft.KeyVault) or with the -[Azure CLI](https://docs.microsoft.com/en-us/azure/key-vault/secrets/quick-create-cli). +[Azure CLI](https://docs.microsoft.com/azure/key-vault/secrets/quick-create-cli). Azure Key Vault is used only to demonstrate authentication. Azure Identity has the same API for all compatible client libraries. diff --git a/sdk/search/azure-search-documents/README.md b/sdk/search/azure-search-documents/README.md index b1a0a37e3920..9c07a2f9eb41 100644 --- a/sdk/search/azure-search-documents/README.md +++ b/sdk/search/azure-search-documents/README.md @@ -38,7 +38,7 @@ Use the Azure.Search.Documents client library to: [Package (PyPI)](https://pypi.org/project/azure-search-documents/) | [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/index.html) | [Product documentation](https://docs.microsoft.com/azure/search/search-what-is-azure-search) | -[Samples](samples) +[Samples](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/search/azure-search-documents/samples) ## Getting started @@ -179,7 +179,7 @@ exploring online resources._ The following examples all use a simple [Hotel data set](https://docs.microsoft.com/samples/azure-samples/azure-search-sample-data/azure-search-sample-data/) that you can [import into your own index from the Azure portal.](https://docs.microsoft.com/azure/search/search-get-started-portal#step-1---start-the-import-data-wizard-and-create-a-data-source) -These are just a few of the basics - please [check out our Samples](samples) for +These are just a few of the basics - please [check out our Samples](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/search/azure-search-documents/samples) for much more. @@ -398,7 +398,7 @@ result = client.search(search_text="spa", logging_enable=True) ## Next steps -* Go further with Azure.Search.Documents and our [samples](samples) +* Go further with Azure.Search.Documents and our [https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/search/azure-search-documents/samples](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/search/azure-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) @@ -428,7 +428,7 @@ additional questions or comments. ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fsearch%2Fazure-search-documents%2FREADME.png) [azure_cli]: https://docs.microsoft.com/cli/azure -[azure_core]: ../../core/azure-core/README.md +[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/README.md [azure_sub]: https://azure.microsoft.com/free/ [search_resource]: https://docs.microsoft.com/azure/search/search-create-service-portal [azure_portal]: https://portal.azure.com diff --git a/sdk/search/azure-search-documents/samples/README.md b/sdk/search/azure-search-documents/samples/README.md index bb8deebd3b8d..064630026336 100644 --- a/sdk/search/azure-search-documents/samples/README.md +++ b/sdk/search/azure-search-documents/samples/README.md @@ -16,7 +16,7 @@ and require Python version 3.5 or later. Authenticate the client with a Azure Cognitive Search [API Key Credential](https://docs.microsoft.com/azure/search/search-security-api-keys): -[sample_authentication.py](sample_authentication.py) ([async version](async_samples/sample_authentication_async.py)) +[https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/search/azure-search-documents/samples/sample_authentication.py](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/search/azure-search-documents/samples/sample_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/search/azure-search-documents/samples/async_samples/sample_authentication_async.py)) Then for common search index operations: diff --git a/sdk/servicebus/azure-servicebus/README.md b/sdk/servicebus/azure-servicebus/README.md index 83372a20dcf4..5944f176a3f8 100644 --- a/sdk/servicebus/azure-servicebus/README.md +++ b/sdk/servicebus/azure-servicebus/README.md @@ -125,6 +125,7 @@ with ServiceBusClient.from_connection_string(connstr) as client: ``` > **NOTE:** A message may be scheduled for delayed delivery using the `ServiceBusSender.schedule_messages()` method, or by specifying `Message.scheduled_enqueue_time_utc` before calling `ServiceBusSender.send_messages()` + > For more detail on scheduling and schedule cancellation please see a sample [here](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/servicebus/azure-servicebus/samples/sync_samples/schedule_messages_and_cancellation.py). ### Receive messages from a queue diff --git a/sdk/sql/azure-mgmt-sql/CHANGELOG.md b/sdk/sql/azure-mgmt-sql/CHANGELOG.md index c965ca202c5a..76ea84671db0 100644 --- a/sdk/sql/azure-mgmt-sql/CHANGELOG.md +++ b/sdk/sql/azure-mgmt-sql/CHANGELOG.md @@ -692,10 +692,10 @@ Operations removed: - Added ReadScale, SampleName, ServerState - Added missing Database properties (failover_group_id, restore_point_in_time, read_scale, sample_name) - - Added missing ElasticPoolActivity properties ([requested]()*) + - Added missing ElasticPoolActivity properties ([requested](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/sql/azure-mgmt-sql)*) - Added missing ReplicationLink properties (is_termination_allowed, replication_mode) - - Added missing Server properties ([external_administrator]()*, + - Added missing Server properties ([external_administrator](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/sql/azure-mgmt-sql)*, state) - Added operations APIs - Removed unused Database.upgrade_hint property diff --git a/sdk/storage/README.md b/sdk/storage/README.md index 5ce0691163c6..883e1b90f38a 100644 --- a/sdk/storage/README.md +++ b/sdk/storage/README.md @@ -28,12 +28,12 @@ or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. -[blobs]: ./azure-storage-blob/README.md -[queues]: ./azure-storage-queue/README.md -[fileshares]: ./azure-storage-file-share/README.md -[datalake]: ./azure-storage-file-datalake/README.md -[management]: ./azure-mgmt-storage/ -[storage_contrib]: ./../../CONTRIBUTING.md +[blobs]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/storage/azure-storage-blob/README.md +[queues]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/storage/azure-storage-queue/README.md +[fileshares]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/storage/azure-storage-file-share/README.md +[datalake]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/storage/azure-storage-file-datalake/README.md +[management]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/storage/azure-mgmt-storage/ +[storage_contrib]: https://github.com/Azure/azure-sdk-for-python/blob/master/CONTRIBUTING.md [cla]: https://cla.microsoft.com [coc]: https://opensource.microsoft.com/codeofconduct/ [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ diff --git a/sdk/tables/azure-data-tables/README.md b/sdk/tables/azure-data-tables/README.md index 06bfc6ce8d6b..cc055a7e3fc3 100644 --- a/sdk/tables/azure-data-tables/README.md +++ b/sdk/tables/azure-data-tables/README.md @@ -64,7 +64,7 @@ az storage account show -n mystorageaccount -g MyResourceGroup --query "primaryE The `credential` parameter may be provided in a number of different forms, depending on the type of authorization you wish to use: ##### Creating the client from a SAS token -To use a [shared access signature (SAS) token][azure_sas_token], provide the token as a string. If your account URL includes the SAS token, omit the credential parameter. You can generate a SAS token from the Azure Portal under [Shared access signature](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas) or use one of the `generate_*_sas()` +To use a [shared access signature (SAS) token][azure_sas_token], provide the token as a string. If your account URL includes the SAS token, omit the credential parameter. You can generate a SAS token from the Azure Portal under [Shared access signature](https://docs.microsoft.com/rest/api/storageservices/create-service-sas) or use one of the `generate_*_sas()` functions to create a sas token for the account or table: ```python @@ -314,25 +314,25 @@ This project has adopted the [Microsoft Open Source Code of Conduct][msft_oss_co [source_code]:https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables [Tables_pypi]:https://aka.ms/azsdk/python/tablespypi [Tables_ref_docs]:https://aka.ms/azsdk/python/tablesgitdocs -[Tables_product_doc]:https://docs.microsoft.com/en-us/azure/cosmos-db/table-introduction +[Tables_product_doc]:https://docs.microsoft.com/azure/cosmos-db/table-introduction [Tables_samples]:https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples -[azure_subscription]:https://azure.microsoft.com/en-us/free/ -[azure_storage_account]:https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal -[azure_cosmos_account]: https://docs.microsoft.com/en-us/azure/cosmos-db/account-overview +[azure_subscription]:https://azure.microsoft.com/free/ +[azure_storage_account]:https://docs.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-portal +[azure_cosmos_account]: https://docs.microsoft.com/azure/cosmos-db/account-overview [pip_link]:https://pypi.org/project/pip/ -[azure_create_cosmos]:https://docs.microsoft.com/en-us/azure/cosmos-db/create-cosmosdb-resources-portal -[azure_portal_create_account]:https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal -[azure_powershell_create_account]:https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-powershell -[azure_cli_create_account]: https://docs.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-cli +[azure_create_cosmos]:https://docs.microsoft.com/azure/cosmos-db/create-cosmosdb-resources-portal +[azure_portal_create_account]:https://docs.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-portal +[azure_powershell_create_account]:https://docs.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-powershell +[azure_cli_create_account]: https://docs.microsoft.com/azure/storage/common/storage-account-create?tabs=azure-cli -[azure_cli_account_url]:https://docs.microsoft.com/en-us/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show -[azure_powershell_account_url]:https://docs.microsoft.com/en-us/powershell/module/az.storage/get-azstorageaccount?view=azps-4.6.1 -[azure_portal_account_url]:https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview#storage-account-endpoints +[azure_cli_account_url]:https://docs.microsoft.com/cli/azure/storage/account?view=azure-cli-latest#az-storage-account-show +[azure_powershell_account_url]:https://docs.microsoft.com/powershell/module/az.storage/get-azstorageaccount?view=azps-4.6.1 +[azure_portal_account_url]:https://docs.microsoft.com/azure/storage/common/storage-account-overview#storage-account-endpoints -[azure_sas_token]:https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview -[azure_shared_key]:https://docs.microsoft.com/en-us/rest/api/storageservices/authorize-with-shared-key +[azure_sas_token]:https://docs.microsoft.com/azure/storage/common/storage-sas-overview +[azure_shared_key]:https://docs.microsoft.com/rest/api/storageservices/authorize-with-shared-key [azure_core_ref_docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html @@ -345,6 +345,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct][msft_oss_co [msft_oss_coc_faq]:https://opensource.microsoft.com/codeofconduct/faq/ [contact_msft_oss]:mailto:opencode@microsoft.com -[tables_rest]: https://docs.microsoft.com/en-us/rest/api/storageservices/table-service-rest-api +[tables_rest]: https://docs.microsoft.com/rest/api/storageservices/table-service-rest-api ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/tables/azure-data-tables/README.png)