| page_type | languages | products | description | urlFragment | ||
|---|---|---|---|---|---|---|
sample |
|
|
These code samples will show you how to manage Communication Service resources using Azure SDK for Python. |
communication |
These code samples will show you how to manage Communication Service resources using Azure SDK for Python.
This project framework provides examples for the following services:
- Using the Azure SDK for Python - Communication Management Library azure-mgmt-communication for the Azure Communication API
-
Before we run the samples, we need to make sure we have setup the credentials. Follow the instructions in register a new application using Azure portal to obtain
subscription id,client id,client secret, andapplication id -
Store your credentials an environment variables. For example, in Linux-based OS, you can do
export AZURE_TENANT_ID="xxx"
export AZURE_CLIENT_ID="xxx"
export AZURE_CLIENT_SECRET="xxx"
export AZURE_SUBSCRIPTION_ID="xxx"
export AZURE_NOTIFICATION_HUB_ID="xxx"
export AZURE_NOTIFICATION_HUB_CONNECTION_STRING="xxx"-
If you don't already have it, install Python.
This sample (and the SDK) is compatible with Python 2.7, 3.3, 3.4, 3.5 and 3.6.
-
General recommendation for Python development is to use a Virtual Environment. For more information, see https://docs.python.org/3/tutorial/venv.html
Install and initialize the virtual environment with the "venv" module on Python 3 (you must install virtualenv for Python 2.7):
python -m venv mytestenv # Might be "python3" or "py -3.6" depending on your Python installation cd mytestenv source bin/activate # Linux shell (Bash, ZSH, etc.) only ./scripts/activate # PowerShell only ./scripts/activate.bat # Windows CMD only
-
Clone the repository.
git clone https://github.com/Azure-Samples/azure-samples-python-management.git -
Install the dependencies using pip.
cd azure-samples-python-management/samples/communication pip install -r requirements.txt
A demo app is included to show how to use the project. This app covers the following scenarios:
- Create a Communication Service
- Fetch a Communication Service
- Update a Communication Service
- Delete a Communication Service
- List all Communication Services in the subscription
- List all Communication Services in the resource group
- List the Primary and Secondary key pairs
- Regenerate the Primary or Secondary key pair
- Link a Notification Hub to the Communication Service
To view all available commands for the demo, execute python manage_communication.py -h
To run the complete demo, execute python manage_communication.py all
The sample files do not have dependency each other and each file represents an individual end-to-end scenario. Please look at the sample that contains the scenario you are interested in