azure-mgmt-webpubsub 2.0.0
Microsoft Azure WebPubSub Management Client Library for Python
License: MIT License
Requires Python: >=3.8
Keywords: azure, azure sdk

# 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