# Microsoft Azure SDK for Python
This is the Microsoft Azure WebPubSub 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-webpubsub
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.webpubsub import WebPubSubManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = WebPubSubManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```
## Examples
Code samples for this package can be found at:
- [Search WebPubSub 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.0.0 (2024-09-23)
### Features Added
- The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replicas' added in the current version
- The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replica_shared_private_link_resources' added in the current version
- The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replicas' added in the current version
- The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replica_shared_private_link_resources' added in the current version
- The 'WebPubSubOperations' method 'list_replica_skus' was added in the current version
- The model or publicly exposed class 'WebPubSubReplicaSharedPrivateLinkResourcesOperations' was added in the current version
- The model or publicly exposed class 'WebPubSubReplicasOperations' was added in the current version
- The 'WebPubSubOperations' method 'list_replica_skus' was added in the current version
- The model or publicly exposed class 'WebPubSubReplicaSharedPrivateLinkResourcesOperations' was added in the current version
- The model or publicly exposed class 'WebPubSubReplicasOperations' was added in the current version
- The model or publicly exposed class 'Resource' had property 'system_data' added in the current version
- The model or publicly exposed class 'WebPubSubHubProperties' had property 'web_socket_keep_alive_interval_in_seconds' added in the current version
- The model or publicly exposed class 'WebPubSubNetworkACLs' had property 'ip_rules' added in the current version
- The model or publicly exposed class 'WebPubSubResource' had property 'kind' added in the current version
- The model or publicly exposed class 'WebPubSubResource' had property 'region_endpoint_enabled' added in the current version
- The model or publicly exposed class 'WebPubSubResource' had property 'resource_stopped' added in the current version
- The model or publicly exposed class 'WebPubSubResource' had property 'socket_io' added in the current version
- The model or publicly exposed class 'IPRule' was added in the current version
- The model or publicly exposed class 'Replica' was added in the current version
- The model or publicly exposed class 'ReplicaList' was added in the current version
- The model or publicly exposed class 'ServiceKind' was added in the current version
- The model or publicly exposed class 'WebPubSubSocketIOSettings' was added in the current version
### Breaking Changes
- Parameter `location` of model `TrackedResource` is now required
- Parameter `location` of model `WebPubSubResource` is now required
## 2.0.0b2 (2023-10-23)
### Features Added
- Model Replica has a new parameter region_endpoint_enabled
- Model Replica has a new parameter resource_stopped
- Model WebPubSubNetworkACLs has a new parameter ip_rules
- Model WebPubSubResource has a new parameter region_endpoint_enabled
- Model WebPubSubResource has a new parameter resource_stopped
## 2.0.0b1 (2023-07-21)
### Features Added
- Added operation WebPubSubOperations.list_replica_skus
- Added operation group WebPubSubReplicasOperations
- Model PrivateLinkResource has a new parameter system_data
- Model ProxyResource has a new parameter system_data
- Model Resource has a new parameter system_data
- Model TrackedResource has a new parameter system_data
- Model WebPubSubResource has a new parameter kind
### Breaking Changes
- Parameter location of model TrackedResource is now required
- Parameter location of model WebPubSubResource is now required
## 1.1.0 (2023-03-20)
### Features Added
- Added operation group WebPubSubCustomCertificatesOperations
- Added operation group WebPubSubCustomDomainsOperations
- Model WebPubSubHubProperties has a new parameter event_listeners
## 1.1.0b1 (2022-11-02)
### Features Added
- Added operation group WebPubSubCustomCertificatesOperations
- Added operation group WebPubSubCustomDomainsOperations
- Model WebPubSubHubProperties has a new parameter event_listeners
## 1.0.0 (2021-10-11)
**Features**
- Model PrivateEndpointConnection has a new parameter group_ids
- Model WebPubSubResource has a new parameter host_name_prefix
- Model WebPubSubResource has a new parameter disable_local_auth
- Model WebPubSubResource has a new parameter resource_log_configuration
- Model WebPubSubResource has a new parameter live_trace_configuration
- Model WebPubSubResource has a new parameter disable_aad_auth
- Added operation WebPubSubOperations.list_skus
- Added operation group WebPubSubHubsOperations
**Breaking changes**
- Model WebPubSubResource no longer has parameter features
- Model WebPubSubResource no longer has parameter event_handler
## 1.0.0b1 (2021-04-16)
* Initial Release
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-mgmt-webpubsub",
"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/83/b4/f1b917e598c0e96083e4858125464d7851e75c51f11fc310d128a47a26a3/azure_mgmt_webpubsub-2.0.0.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure WebPubSub 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-webpubsub\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.webpubsub import WebPubSubManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = WebPubSubManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search WebPubSub 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.0.0 (2024-09-23)\n\n### Features Added\n\n - The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replicas' added in the current version\n - The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replica_shared_private_link_resources' added in the current version\n - The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replicas' added in the current version\n - The 'WebPubSubManagementClient' client had operation group 'web_pub_sub_replica_shared_private_link_resources' added in the current version\n - The 'WebPubSubOperations' method 'list_replica_skus' was added in the current version\n - The model or publicly exposed class 'WebPubSubReplicaSharedPrivateLinkResourcesOperations' was added in the current version\n - The model or publicly exposed class 'WebPubSubReplicasOperations' was added in the current version\n - The 'WebPubSubOperations' method 'list_replica_skus' was added in the current version\n - The model or publicly exposed class 'WebPubSubReplicaSharedPrivateLinkResourcesOperations' was added in the current version\n - The model or publicly exposed class 'WebPubSubReplicasOperations' was added in the current version\n - The model or publicly exposed class 'Resource' had property 'system_data' added in the current version\n - The model or publicly exposed class 'WebPubSubHubProperties' had property 'web_socket_keep_alive_interval_in_seconds' added in the current version\n - The model or publicly exposed class 'WebPubSubNetworkACLs' had property 'ip_rules' added in the current version\n - The model or publicly exposed class 'WebPubSubResource' had property 'kind' added in the current version\n - The model or publicly exposed class 'WebPubSubResource' had property 'region_endpoint_enabled' added in the current version\n - The model or publicly exposed class 'WebPubSubResource' had property 'resource_stopped' added in the current version\n - The model or publicly exposed class 'WebPubSubResource' had property 'socket_io' added in the current version\n - The model or publicly exposed class 'IPRule' was added in the current version\n - The model or publicly exposed class 'Replica' was added in the current version\n - The model or publicly exposed class 'ReplicaList' was added in the current version\n - The model or publicly exposed class 'ServiceKind' was added in the current version\n - The model or publicly exposed class 'WebPubSubSocketIOSettings' was added in the current version\n\n### Breaking Changes\n\n - Parameter `location` of model `TrackedResource` is now required\n - Parameter `location` of model `WebPubSubResource` is now required\n\n## 2.0.0b2 (2023-10-23)\n\n### Features Added\n\n - Model Replica has a new parameter region_endpoint_enabled\n - Model Replica has a new parameter resource_stopped\n - Model WebPubSubNetworkACLs has a new parameter ip_rules\n - Model WebPubSubResource has a new parameter region_endpoint_enabled\n - Model WebPubSubResource has a new parameter resource_stopped\n\n## 2.0.0b1 (2023-07-21)\n\n### Features Added\n\n - Added operation WebPubSubOperations.list_replica_skus\n - Added operation group WebPubSubReplicasOperations\n - Model PrivateLinkResource has a new parameter system_data\n - Model ProxyResource has a new parameter system_data\n - Model Resource has a new parameter system_data\n - Model TrackedResource has a new parameter system_data\n - Model WebPubSubResource has a new parameter kind\n\n### Breaking Changes\n\n - Parameter location of model TrackedResource is now required\n - Parameter location of model WebPubSubResource is now required\n\n## 1.1.0 (2023-03-20)\n\n### Features Added\n\n - Added operation group WebPubSubCustomCertificatesOperations\n - Added operation group WebPubSubCustomDomainsOperations\n - Model WebPubSubHubProperties has a new parameter event_listeners\n\n## 1.1.0b1 (2022-11-02)\n\n### Features Added\n\n - Added operation group WebPubSubCustomCertificatesOperations\n - Added operation group WebPubSubCustomDomainsOperations\n - Model WebPubSubHubProperties has a new parameter event_listeners\n\n## 1.0.0 (2021-10-11)\n\n**Features**\n\n - Model PrivateEndpointConnection has a new parameter group_ids\n - Model WebPubSubResource has a new parameter host_name_prefix\n - Model WebPubSubResource has a new parameter disable_local_auth\n - Model WebPubSubResource has a new parameter resource_log_configuration\n - Model WebPubSubResource has a new parameter live_trace_configuration\n - Model WebPubSubResource has a new parameter disable_aad_auth\n - Added operation WebPubSubOperations.list_skus\n - Added operation group WebPubSubHubsOperations\n\n**Breaking changes**\n\n - Model WebPubSubResource no longer has parameter features \n - Model WebPubSubResource no longer has parameter event_handler\n\n## 1.0.0b1 (2021-04-16)\n\n* Initial Release\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure WebPubSub Management Client Library for Python",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "466807fc3b9428d1317152ae015950bd6ef6dbd3fb93c3b0af8910c2ddd571e7",
"md5": "cb9119660322d4bf3f19b57680b7db6f",
"sha256": "b9cbcfd4ec6bea2f03a4556bc219ada1681152fcba92912ad8d7672b2cefef40"
},
"downloads": -1,
"filename": "azure_mgmt_webpubsub-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb9119660322d4bf3f19b57680b7db6f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 135342,
"upload_time": "2024-09-24T09:40:33",
"upload_time_iso_8601": "2024-09-24T09:40:33.390471Z",
"url": "https://files.pythonhosted.org/packages/46/68/07fc3b9428d1317152ae015950bd6ef6dbd3fb93c3b0af8910c2ddd571e7/azure_mgmt_webpubsub-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "83b4f1b917e598c0e96083e4858125464d7851e75c51f11fc310d128a47a26a3",
"md5": "3307db5587bec287fb0170588fa9b125",
"sha256": "0464e7bf0aa964904255d1db6713c80f925365bfe1c87c23a8f1d661d879f2e6"
},
"downloads": -1,
"filename": "azure_mgmt_webpubsub-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3307db5587bec287fb0170588fa9b125",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 79640,
"upload_time": "2024-09-24T09:40:31",
"upload_time_iso_8601": "2024-09-24T09:40:31.650224Z",
"url": "https://files.pythonhosted.org/packages/83/b4/f1b917e598c0e96083e4858125464d7851e75c51f11fc310d128a47a26a3/azure_mgmt_webpubsub-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-24 09:40:31",
"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-webpubsub"
}
JSON
