azure-mgmt-communication


Nameazure-mgmt-communication JSON
Version 2.1.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-sdk-for-python
SummaryMicrosoft Azure Communication Management Client Library for Python
upload_time2024-03-18 05:51:43
maintainerNone
docs_urlNone
authorMicrosoft Corporation
requires_python>=3.8
licenseMIT License
keywords azure azure sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Microsoft Azure SDK for Python

This is the Microsoft Azure Communication Management Client Library.
This package has been tested with Python 3.8+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

## Getting started

### Prerequisites

- Python 3.8+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-communication
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.communication import CommunicationServiceManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = CommunicationServiceManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search Communication Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project. 


# Release History

## 2.1.0 (2024-03-18)

### Features Added

  - Model CommunicationServiceResource has a new parameter identity
  - Model CommunicationServiceResourceUpdate has a new parameter identity

## 2.1.0b2 (2023-12-18)

### Features Added

  - Added operation group SuppressionListAddressesOperations
  - Added operation group SuppressionListsOperations

## 2.1.0b1 (2023-09-19)

### Features Added

  - Model CommunicationServiceResource has a new parameter identity
  - Model CommunicationServiceResourceUpdate has a new parameter identity

## 2.0.0 (2023-04-03)

### Features Added

  - Added operation group CommunicationServicesOperations
  - Added operation group DomainsOperations
  - Added operation group EmailServicesOperations
  - Added operation group SenderUsernamesOperations
  - Model CommunicationServiceResource has a new parameter linked_domains
  - Model Resource has a new parameter system_data

### Breaking Changes

  - Parameter location of model CommunicationServiceResource is now required
  - Removed operation group CommunicationServiceOperations
  - Removed operation group OperationStatusesOperations

## 2.0.0b3 (2023-03-23)

### Features Added

  - Added operation CommunicationServicesOperations.regenerate_key
  - Added operation CommunicationServicesOperations.update
  - Added operation group SenderUsernamesOperations

### Breaking Changes

  - Model DomainResource no longer has parameter valid_sender_usernames
  - Model UpdateDomainRequestParameters no longer has parameter valid_sender_usernames
  - Removed operation CommunicationServicesOperations.begin_regenerate_key
  - Removed operation CommunicationServicesOperations.begin_update

## 2.0.0b2 (2022-11-28)

### Other Changes

  - Added generated samples in github repo
  - Drop support for python<3.7.0

## 2.0.0b1 (2022-06-07)

**Features**

  - Added operation group CommunicationServicesOperations
  - Added operation group DomainsOperations
  - Added operation group EmailServicesOperations
  - Model CommunicationServiceResource has a new parameter linked_domains
  - Model Resource has a new parameter system_data

**Breaking changes**

  - Parameter location of model CommunicationServiceResource is now required
  - Removed operation group CommunicationServiceOperations
  - Removed operation group OperationStatusesOperations

## 1.0.0 (2021-03-29)

**Features**

  - Model CommunicationServiceResource has a new parameter system_data
  - Model Operation has a new parameter action_type
  - Model Operation has a new parameter is_data_action
  - Added operation CommunicationServiceOperations.check_name_availability

**Breaking changes**

  - Model Operation no longer has parameter properties



## 1.0.0b4 (2020-11-16)
- Updated `azure-mgmt-communication` version.

## 1.0.0b3 (2020-10-06)
- Updated `azure-mgmt-communication` version.

## 1.0.0b2 (2020-09-22)

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

**General breaking changes**

- Credential system has been completly revamped:

  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
  - `credentials` parameter has been renamed `credential`

- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:

  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
  - For a complete set of
  supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

**General new features**

- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.


## 1.0.0b1 (2020-09-22)

* Initial Release

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-mgmt-communication",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "azure,azure sdk",
    "author": "Microsoft Corporation",
    "author_email": "azpysdkhelp@microsoft.com",
    "download_url": "https://files.pythonhosted.org/packages/1f/c7/1564f5f5ad724343dc4a94679ad4d0aca879426cf426b80506dab8f58219/azure-mgmt-communication-2.1.0.tar.gz",
    "platform": null,
    "description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Communication Management Client Library.\nThis package has been tested with Python 3.8+.\nFor a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).\n\n## _Disclaimer_\n\n_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_\n\n## Getting started\n\n### Prerequisites\n\n- Python 3.8+ is required to use this package.\n- [Azure subscription](https://azure.microsoft.com/free/)\n\n### Install the package\n\n```bash\npip install azure-mgmt-communication\npip install azure-identity\n```\n\n### Authentication\n\nBy default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.\n\n- `AZURE_CLIENT_ID` for Azure client ID.\n- `AZURE_TENANT_ID` for Azure tenant ID.\n- `AZURE_CLIENT_SECRET` for Azure client secret.\n\nIn addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.\n\nWith above configuration, client can be authenticated by following code:\n\n```python\nfrom azure.identity import DefaultAzureCredential\nfrom azure.mgmt.communication import CommunicationServiceManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = CommunicationServiceManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Communication Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com\n- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)\n\n\n## Troubleshooting\n\n## Next steps\n\n## Provide Feedback\n\nIf you encounter any bugs or have suggestions, please file an issue in the\n[Issues](https://github.com/Azure/azure-sdk-for-python/issues)\nsection of the project. \n\n\n# Release History\n\n## 2.1.0 (2024-03-18)\n\n### Features Added\n\n  - Model CommunicationServiceResource has a new parameter identity\n  - Model CommunicationServiceResourceUpdate has a new parameter identity\n\n## 2.1.0b2 (2023-12-18)\n\n### Features Added\n\n  - Added operation group SuppressionListAddressesOperations\n  - Added operation group SuppressionListsOperations\n\n## 2.1.0b1 (2023-09-19)\n\n### Features Added\n\n  - Model CommunicationServiceResource has a new parameter identity\n  - Model CommunicationServiceResourceUpdate has a new parameter identity\n\n## 2.0.0 (2023-04-03)\n\n### Features Added\n\n  - Added operation group CommunicationServicesOperations\n  - Added operation group DomainsOperations\n  - Added operation group EmailServicesOperations\n  - Added operation group SenderUsernamesOperations\n  - Model CommunicationServiceResource has a new parameter linked_domains\n  - Model Resource has a new parameter system_data\n\n### Breaking Changes\n\n  - Parameter location of model CommunicationServiceResource is now required\n  - Removed operation group CommunicationServiceOperations\n  - Removed operation group OperationStatusesOperations\n\n## 2.0.0b3 (2023-03-23)\n\n### Features Added\n\n  - Added operation CommunicationServicesOperations.regenerate_key\n  - Added operation CommunicationServicesOperations.update\n  - Added operation group SenderUsernamesOperations\n\n### Breaking Changes\n\n  - Model DomainResource no longer has parameter valid_sender_usernames\n  - Model UpdateDomainRequestParameters no longer has parameter valid_sender_usernames\n  - Removed operation CommunicationServicesOperations.begin_regenerate_key\n  - Removed operation CommunicationServicesOperations.begin_update\n\n## 2.0.0b2 (2022-11-28)\n\n### Other Changes\n\n  - Added generated samples in github repo\n  - Drop support for python<3.7.0\n\n## 2.0.0b1 (2022-06-07)\n\n**Features**\n\n  - Added operation group CommunicationServicesOperations\n  - Added operation group DomainsOperations\n  - Added operation group EmailServicesOperations\n  - Model CommunicationServiceResource has a new parameter linked_domains\n  - Model Resource has a new parameter system_data\n\n**Breaking changes**\n\n  - Parameter location of model CommunicationServiceResource is now required\n  - Removed operation group CommunicationServiceOperations\n  - Removed operation group OperationStatusesOperations\n\n## 1.0.0 (2021-03-29)\n\n**Features**\n\n  - Model CommunicationServiceResource has a new parameter system_data\n  - Model Operation has a new parameter action_type\n  - Model Operation has a new parameter is_data_action\n  - Added operation CommunicationServiceOperations.check_name_availability\n\n**Breaking changes**\n\n  - Model Operation no longer has parameter properties\n\n\n\n## 1.0.0b4 (2020-11-16)\n- Updated `azure-mgmt-communication` version.\n\n## 1.0.0b3 (2020-10-06)\n- Updated `azure-mgmt-communication` version.\n\n## 1.0.0b2 (2020-09-22)\n\nThis version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).\n\n**General breaking changes**\n\n- Credential system has been completly revamped:\n\n  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/\n  - `credentials` parameter has been renamed `credential`\n\n- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of\n  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n- You can't import a `version` module anymore, use `__version__` instead\n- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.\n- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).\n- Most of the operation kwarg have changed. Some of the most noticeable:\n\n  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user\n  - For a complete set of\n  supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n\n**General new features**\n\n- Type annotations support using `typing`. SDKs are mypy ready.\n- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.\n- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.\n\n\n## 1.0.0b1 (2020-09-22)\n\n* Initial Release\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure Communication Management Client Library for Python",
    "version": "2.1.0",
    "project_urls": {
        "Homepage": "https://github.com/Azure/azure-sdk-for-python"
    },
    "split_keywords": [
        "azure",
        "azure sdk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6c33d187f0f851d7f34fb7c922da72ec4c511dbdc32f846818d1b0d694fc1710",
                "md5": "af5b8399367a3c5d079b804006b327e4",
                "sha256": "c9d57252f0061cbd5e57b4215f51e9139ba8b2a5c0cdc389ee0f85dc0f9913a8"
            },
            "downloads": -1,
            "filename": "azure_mgmt_communication-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "af5b8399367a3c5d079b804006b327e4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 89751,
            "upload_time": "2024-03-18T05:51:46",
            "upload_time_iso_8601": "2024-03-18T05:51:46.233784Z",
            "url": "https://files.pythonhosted.org/packages/6c/33/d187f0f851d7f34fb7c922da72ec4c511dbdc32f846818d1b0d694fc1710/azure_mgmt_communication-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1fc71564f5f5ad724343dc4a94679ad4d0aca879426cf426b80506dab8f58219",
                "md5": "5599e392043e759d87f0258d3a9cc538",
                "sha256": "fa61e80e1a6b00cd739932e6267a9f3ef44c838ab85ce8c95d7620e8997f4664"
            },
            "downloads": -1,
            "filename": "azure-mgmt-communication-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5599e392043e759d87f0258d3a9cc538",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 72215,
            "upload_time": "2024-03-18T05:51:43",
            "upload_time_iso_8601": "2024-03-18T05:51:43.831650Z",
            "url": "https://files.pythonhosted.org/packages/1f/c7/1564f5f5ad724343dc4a94679ad4d0aca879426cf426b80506dab8f58219/azure-mgmt-communication-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-18 05:51:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Azure",
    "github_project": "azure-sdk-for-python",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "azure-mgmt-communication"
}
        
Elapsed time: 0.20584s