Skip to content

Commit

Permalink
Fix urls (#39248)
Browse files Browse the repository at this point in the history
  • Loading branch information
xiangyan99 authored and w-javed committed Jan 23, 2025
1 parent eb60c9b commit f563292
Show file tree
Hide file tree
Showing 15 changed files with 50 additions and 50 deletions.
6 changes: 3 additions & 3 deletions sdk/communication/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ If you ran the tests in LIVE mode, you may have noticed that the files inside th

The most probable thing is that the managed identity tests will fail at first. This is because we haven't set up any managed identity credentials for the DefaultAzureCredential object inside the tests to reference to. There are multiple ways of creating a managed identity credential.

One of the easiest ways is to install the [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli) and run the `az login` command. If you are listed as a contributor of the resource you are testing against, this should be enough for the DefaultAzureCredential object to get the corresponding Azure Active Directory credentials you need.
One of the easiest ways is to install the [Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) and run the `az login` command. If you are listed as a contributor of the resource you are testing against, this should be enough for the DefaultAzureCredential object to get the corresponding Azure Active Directory credentials you need.

Another way to authenticate is to set up 3 environment variables called `AZURE_CLIENT_ID`, `AZURE_TENANT_ID` and `AZURE_CLIENT_SECRET` and set their values to the ones from a registered Azure Active Directory application that is linked to the resource you are testing against.

If you are testing against a personal resource, you can check the [Managed Identity Quickstart Guide for ACS](https://docs.microsoft.com/azure/communication-services/quickstarts/managed-identity-from-cli) for an easy ramp-up process.
If you are testing against a personal resource, you can check the [Managed Identity Quickstart Guide for ACS](https://learn.microsoft.com/azure/communication-services/quickstarts/managed-identity-from-cli) for an easy ramp-up process.

For a more in-depth look on how to authenticate using managed identity, refer to the [Azure Identity client library for Python](https://docs.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python) documentation. This document also has more ways for you to authenticate using the DefaultAzureCredential object besides the ones we discussed in this contributing file.
For a more in-depth look on how to authenticate using managed identity, refer to the [Azure Identity client library for Python](https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python) documentation. This document also has more ways for you to authenticate using the DefaultAzureCredential object besides the ones we discussed in this contributing file.

### Running the New-TestResources and Remove-TestResources Scripts

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ additional questions or comments.

<!-- LINKS -->
[overview]: https://learn.microsoft.com/azure/communication-services/concepts/voice-video-calling/call-automation
[product_docs]: https://docs.microsoft.com/azure/communication-services/overview
[azure_cli]: https://docs.microsoft.com/cli/azure
[product_docs]: https://learn.microsoft.com/azure/communication-services/overview
[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_powershell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
[azure_powershell]: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
[build_doc]: https://aka.ms/AzureSDKBundling
[incomingcall]: https://learn.microsoft.com/azure/communication-services/concepts/voice-video-calling/incoming-call-notification
[build1]: https://learn.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/callflows-for-customer-interactions?pivots=programming-language-csha
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6238,14 +6238,14 @@ class TextSource(_serialization.Model):
:vartype text: str
:ivar source_locale: Source language locale to be played
Refer to available locales here: :code:`<seealso
href="https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
href="https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
/>`.
:vartype source_locale: str
:ivar voice_kind: Voice kind type. Known values are: "male" and "female".
:vartype voice_kind: str or ~azure.communication.callautomation.models.VoiceKind
:ivar voice_name: Voice name to be played
Refer to available Text-to-speech voices here: :code:`<seealso
href="https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
href="https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
/>`.
:vartype voice_name: str
:ivar custom_voice_endpoint_id: Endpoint where the custom voice was deployed.
Expand Down Expand Up @@ -6279,14 +6279,14 @@ def __init__(
:paramtype text: str
:keyword source_locale: Source language locale to be played
Refer to available locales here: :code:`<seealso
href="https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
href="https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
/>`.
:paramtype source_locale: str
:keyword voice_kind: Voice kind type. Known values are: "male" and "female".
:paramtype voice_kind: str or ~azure.communication.callautomation.models.VoiceKind
:keyword voice_name: Voice name to be played
Refer to available Text-to-speech voices here: :code:`<seealso
href="https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
href="https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"
/>`.
:paramtype voice_name: str
:keyword custom_voice_endpoint_id: Endpoint where the custom voice was deployed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,12 +259,12 @@ class TextSource:
:keyword text: Text for the cognitive service to be played. Required.
:paramtype text: str
:keyword source_locale: Source language locale to be played. Refer to available locales here:
https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts
https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts
:paramtype source_locale: str
:keyword voice_kind: Voice kind type. Known values are: "male" and "female".
:paramtype voice_kind: str or ~azure.communication.callautomation.VoiceKind
:keyword voice_name: Voice name to be played. Refer to available Text-to-speech voices here:
https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts
https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts
:paramtype voice_name: str
:keyword play_source_cache_id: Cached source id of the play media, if it exists.
:paramtype play_source_cache_id: str
Expand All @@ -276,12 +276,12 @@ class TextSource:
"""Text for the cognitive service to be played."""
source_locale: Optional[str]
"""Source language locale to be played. Refer to available locales here:
https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"""
https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"""
voice_kind: Optional[Union[str, "VoiceKind"]]
"""Voice kind type. Known values are: "male" and "female"."""
voice_name: Optional[str]
"""Voice name to be played. Refer to available Text-to-speech voices here:
https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"""
https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support?tabs=stt-tts"""
play_source_cache_id: Optional[str]
"""Cached source id of the play media, if it exists."""
custom_voice_endpoint_id: Optional[str]
Expand Down
6 changes: 3 additions & 3 deletions sdk/communication/azure-communication-chat/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Azure Communication Chat Package client library for Python

This package contains a Python SDK for Azure Communication Services for Chat.
Read more about Azure Communication Services [here](https://docs.microsoft.com/azure/communication-services/overview)
Read more about Azure Communication Services [here](https://learn.microsoft.com/azure/communication-services/overview)

[Source code](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/communication/azure-communication-chat)
| [Package (Pypi)](https://pypi.org/project/azure-communication-chat/)
| [Package (Conda)](https://anaconda.org/microsoft/azure-communication/)
| [API reference documentation](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-communication-chat/1.0.0b5/index.html)
| [Product documentation](https://docs.microsoft.com/azure/communication-services/)
| [Product documentation](https://learn.microsoft.com/azure/communication-services/)

## _Disclaimer_

Expand All @@ -18,7 +18,7 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For
## Prerequisites

- Python 3.7 or later is required to use this package.
- A deployed Communication Services resource. You can use the [Azure Portal](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice) to set it up.
- A deployed Communication Services resource. You can use the [Azure Portal](https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice) to set it up.

## Install the package

Expand Down
8 changes: 4 additions & 4 deletions sdk/communication/azure-communication-email/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,11 +232,11 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
[coc]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[coc_contact]: mailto:[email protected]
[communication_resource_docs]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[communication_resource_docs]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[email_resource_docs]: https://aka.ms/acsemail/createemailresource
[communication_resource_create_portal]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[communication_resource_create_power_shell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
[communication_resource_create_net]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-net
[communication_resource_create_portal]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[communication_resource_create_power_shell]: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
[communication_resource_create_net]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-net
[package]: https://www.nuget.org/packages/Azure.Communication.Common/
[product_docs]: https://aka.ms/acsemail/overview
[nextsteps]: https://aka.ms/acsemail/overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@
<!-- LINKS -->

[read_me]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-identity/README.md
[documentation]: https://docs.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-python
[documentation]: https://learn.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-python
4 changes: 2 additions & 2 deletions sdk/communication/azure-communication-identity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Azure Communication Identity client package is intended to be used to setup the
| [Package (Pypi)](https://pypi.org/project/azure-communication-identity/)
| [Package (Conda)](https://anaconda.org/microsoft/azure-communication/)
| [API reference documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-identity)
| [Product documentation](https://docs.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-python)
| [Product documentation](https://learn.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-python)

## _Disclaimer_

Expand All @@ -16,7 +16,7 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For
## Prerequisites
- Python 3.8 or later is required to use this package.
- You must have an [Azure subscription](https://azure.microsoft.com/free/)
- A deployed Communication Services resource. You can use the [Azure Portal](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice) to set it up.
- A deployed Communication Services resource. You can use the [Azure Portal](https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice) to set it up.
## Install the package
Install the Azure Communication Identity client library for Python with [pip](https://pypi.org/project/pip/):

Expand Down
22 changes: 11 additions & 11 deletions sdk/communication/azure-communication-jobrouter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,20 +337,20 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
[coc]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[coc_contact]: mailto:[email protected]
[communication_resource_docs]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[communication_resource_create_portal]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[communication_resource_create_power_shell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
[communication_resource_create_net]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-net
[nextsteps]:https://docs.microsoft.com/azure/communication-services/concepts/router/concepts
[communication_resource_docs]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[communication_resource_create_portal]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp
[communication_resource_create_power_shell]: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
[communication_resource_create_net]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-net
[nextsteps]:https://learn.microsoft.com/azure/communication-services/concepts/router/concepts

[source]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-jobrouter
[product_docs]: https://docs.microsoft.com/azure/communication-services/overview
[classification_concepts]: https://docs.microsoft.com/azure/communication-services/concepts/router/classification-concepts
[subscribe_events]: https://docs.microsoft.com/azure/communication-services/how-tos/router-sdk/subscribe-events
[offer_issued_event_schema]: https://docs.microsoft.com/azure/communication-services/how-tos/router-sdk/subscribe-events#microsoftcommunicationrouterworkerofferissued
[product_docs]: https://learn.microsoft.com/azure/communication-services/overview
[classification_concepts]: https://learn.microsoft.com/azure/communication-services/concepts/router/classification-concepts
[subscribe_events]: https://learn.microsoft.com/azure/communication-services/how-tos/router-sdk/subscribe-events
[offer_issued_event_schema]: https://learn.microsoft.com/azure/communication-services/how-tos/router-sdk/subscribe-events#microsoftcommunicationrouterworkerofferissued
[deserialize_event_grid_event_data]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/eventgrid/azure-eventgrid#consume-from-servicebus
[event_grid_event_handlers]: https://docs.microsoft.com/azure/event-grid/event-handlers
[webhook_event_grid_event_delivery]: https://docs.microsoft.com/azure/event-grid/webhook-event-delivery
[event_grid_event_handlers]: https://learn.microsoft.com/azure/event-grid/event-handlers
[webhook_event_grid_event_delivery]: https://learn.microsoft.com/azure/event-grid/webhook-event-delivery
[pypi]: https://pypi.org
[pip]: https://pypi.org/project/pip/

Expand Down
4 changes: 2 additions & 2 deletions sdk/communication/azure-communication-messages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,14 @@ additional questions or comments.

<!-- LINKS -->
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
[authenticate_with_token]: https://learn.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
[azure_identity_pip]: https://pypi.org/project/azure-identity/
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
[pip]: https://pypi.org/project/pip/
[azure_sub]: https://azure.microsoft.com

[source]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/communication/azure-communication-messages
[product_docs]: https://docs.microsoft.com/azure/communication-services/overview
[product_docs]: https://learn.microsoft.com/azure/communication-services/overview
[pypi]: https://pypi.org
[nextsteps]: https://learn.microsoft.com/azure/communication-services/concepts/advanced-messaging/whatsapp/whatsapp-overview
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
DESCRIPTION:
This sample demonstrates sending an Whatsapp message from business phone number to a single user. The NotificationMessageClient is
authenticated using Bearer TokenCredentials with azureidentity.
More information here: https://learn.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python
More information here: https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python
USAGE:
python send_text_notification_messages_with_token_credentials.py
Expand All @@ -21,8 +21,8 @@
2) RECIPIENT_PHONE_NUMBER - a phone number with Whatsapp capabilities. Use list for recipient phone number.
3) WHATSAPP_CHANNEL_ID - Channel created in Azure portal for Advanced Messaging.
4) Follow defining environment variables for DefaultAzureCredentials as give here:
https://learn.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python#environment-variables
https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal
https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#environment-variables
https://learn.microsoft.com/entra/identity-platform/howto-create-service-principal-portal
Variable name Value
AZURE_CLIENT_ID ID of a Microsoft Entra application
AZURE_TENANT_ID ID of the application's Microsoft Entra tenant
Expand Down
Loading

0 comments on commit f563292

Please sign in to comment.