azure-mgmt-signalr

Name	azure-mgmt-signalr JSON
Version	1.2.0 JSON
	download
home_page	https://github.com/Azure/azure-sdk-for-python
Summary	Microsoft Azure SignalR Client Library for Python
upload_time	2023-03-20 05:46:57
maintainer
docs_url	None
author	Microsoft Corporation
requires_python	>=3.7
license	MIT 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 SignalR Client Library.
This package has been tested with Python 3.7+.
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.7+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-signalr
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.signalr import SignalRManagementClient
import os

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

## Examples


Code samples for this package can be found at [SignalR](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com and [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. 


![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-signalr%2FREADME.png)


# Release History

## 1.2.0 (2023-03-20)

### Features Added

  - Model SignalRResource has a new parameter serverless

## 1.2.0b1 (2022-11-15)

### Features Added

  - Model SignalRResource has a new parameter serverless

## 1.1.0 (2022-03-28)

**Features**

  - Added operation group SignalRCustomCertificatesOperations
  - Added operation group SignalRCustomDomainsOperations
  - Model SignalRResource has a new parameter live_trace_configuration

## 1.0.0 (2021-11-01)

**Features**

  - Model SignalRResource has a new parameter disable_aad_auth
  - Model SignalRResource has a new parameter host_name_prefix
  - Model SignalRResource has a new parameter resource_log_configuration
  - Model SignalRResource has a new parameter disable_local_auth
  - Model SignalRResource has a new parameter public_network_access
  - Model PrivateEndpointConnection has a new parameter group_ids
  - Added operation SignalROperations.list_skus

## 1.0.0b2 (2021-05-20)

**Features**

  - Model SignalRResource has a new parameter shared_private_link_resources
  - Model SignalRResource has a new parameter system_data
  - Model PrivateLinkResource has a new parameter shareable_private_link_resource_types
  - Model PrivateEndpointConnection has a new parameter system_data
  - Added operation SignalRPrivateEndpointConnectionsOperations.list
  - Added operation group SignalRSharedPrivateLinkResourcesOperations

## 1.0.0b1 (2020-12-02)

This is beta preview version.

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.

## 0.4.0 (2020-05-29)

**Features**

  - Model ServiceSpecification has a new parameter log_specifications
  - Model SignalRResource has a new parameter network_ac_ls
  - Model SignalRResource has a new parameter upstream
  - Model SignalRResource has a new parameter private_endpoint_connections
  - Model SignalRResource has a new parameter kind
  - Model Operation has a new parameter is_data_action
  - Model SignalRCreateOrUpdateProperties has a new parameter upstream
  - Model SignalRCreateOrUpdateProperties has a new parameter network_ac_ls
  - Added operation group SignalRPrivateEndpointConnectionsOperations
  - Added operation group SignalRPrivateLinkResourcesOperations

**General Breaking Changes**

This version uses a next-generation code generator that *might*
introduce breaking changes. In summary, some modules were incorrectly
visible/importable and have been renamed. This fixed several issues
caused by usage of classes that were not supposed to be used in the
first place.

  - SignalRClient cannot be imported from
    `azure.mgmt.signalr.signalr_client` anymore (import from
    `azure.mgmt.signalr` works like before)
  - SignalRClientConfiguration import has been moved from
    `azure.mgmt.signalr.signalr_client`
    to `azure.mgmt.signalr`
  - A model `MyClass` from a "models" sub-module cannot be imported
    anymore using `azure.mgmt.signalr.models.my_class` (import from
    `azure.mgmt.signalr.models` works like before)
  - An operation class `MyClassOperations` from an `operations`
    sub-module cannot be imported anymore using
    `azure.mgmt.signalr.operations.my_class_operations` (import from
    `azure.mgmt.signalr.operations` works like before)

Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.

## 0.3.0 (2019-08-06)

**Features**

  - Model SignalRResource has a new parameter cors
  - Model SignalRResource has a new parameter features
  - Model SignalRCreateOrUpdateProperties has a new parameter cors
  - Model SignalRCreateOrUpdateProperties has a new parameter feature

## 0.2.0 (2019-05-21)

  - Add restart operation

## 0.1.1 (2018-09-04)

**Features**

  - Model SignalRKeys has a new parameter secondary_connection_string
  - Model SignalRKeys has a new parameter primary_connection_string
  - Model MetricSpecification has a new parameter dimensions
  - Model SignalRResource has a new parameter version
  - Added operation group UsagesOperations

## 0.1.0 (2018-05-07)

  - Initial Release

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-mgmt-signalr",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "azure,azure sdk",
    "author": "Microsoft Corporation",
    "author_email": "azpysdkhelp@microsoft.com",
    "download_url": "https://files.pythonhosted.org/packages/63/28/acbe742e49ca694467a3b86e740babbc3bf67204bba980f4d1ebf4d1be03/azure-mgmt-signalr-1.2.0.zip",
    "platform": null,
    "description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure SignalR Client Library.\nThis package has been tested with Python 3.7+.\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.7+ 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-signalr\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.signalr import SignalRManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = SignalRManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\n\nCode samples for this package can be found at [SignalR](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com and [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![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-signalr%2FREADME.png)\n\n\n# Release History\n\n## 1.2.0 (2023-03-20)\n\n### Features Added\n\n  - Model SignalRResource has a new parameter serverless\n\n## 1.2.0b1 (2022-11-15)\n\n### Features Added\n\n  - Model SignalRResource has a new parameter serverless\n\n## 1.1.0 (2022-03-28)\n\n**Features**\n\n  - Added operation group SignalRCustomCertificatesOperations\n  - Added operation group SignalRCustomDomainsOperations\n  - Model SignalRResource has a new parameter live_trace_configuration\n\n## 1.0.0 (2021-11-01)\n\n**Features**\n\n  - Model SignalRResource has a new parameter disable_aad_auth\n  - Model SignalRResource has a new parameter host_name_prefix\n  - Model SignalRResource has a new parameter resource_log_configuration\n  - Model SignalRResource has a new parameter disable_local_auth\n  - Model SignalRResource has a new parameter public_network_access\n  - Model PrivateEndpointConnection has a new parameter group_ids\n  - Added operation SignalROperations.list_skus\n\n## 1.0.0b2 (2021-05-20)\n\n**Features**\n\n  - Model SignalRResource has a new parameter shared_private_link_resources\n  - Model SignalRResource has a new parameter system_data\n  - Model PrivateLinkResource has a new parameter shareable_private_link_resource_types\n  - Model PrivateEndpointConnection has a new parameter system_data\n  - Added operation SignalRPrivateEndpointConnectionsOperations.list\n  - Added operation group SignalRSharedPrivateLinkResourcesOperations\n\n## 1.0.0b1 (2020-12-02)\n\nThis is beta preview version.\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## 0.4.0 (2020-05-29)\n\n**Features**\n\n  - Model ServiceSpecification has a new parameter log_specifications\n  - Model SignalRResource has a new parameter network_ac_ls\n  - Model SignalRResource has a new parameter upstream\n  - Model SignalRResource has a new parameter private_endpoint_connections\n  - Model SignalRResource has a new parameter kind\n  - Model Operation has a new parameter is_data_action\n  - Model SignalRCreateOrUpdateProperties has a new parameter upstream\n  - Model SignalRCreateOrUpdateProperties has a new parameter network_ac_ls\n  - Added operation group SignalRPrivateEndpointConnectionsOperations\n  - Added operation group SignalRPrivateLinkResourcesOperations\n\n**General Breaking Changes**\n\nThis version uses a next-generation code generator that *might*\nintroduce breaking changes. In summary, some modules were incorrectly\nvisible/importable and have been renamed. This fixed several issues\ncaused by usage of classes that were not supposed to be used in the\nfirst place.\n\n  - SignalRClient cannot be imported from\n    `azure.mgmt.signalr.signalr_client` anymore (import from\n    `azure.mgmt.signalr` works like before)\n  - SignalRClientConfiguration import has been moved from\n    `azure.mgmt.signalr.signalr_client`\n    to `azure.mgmt.signalr`\n  - A model `MyClass` from a \"models\" sub-module cannot be imported\n    anymore using `azure.mgmt.signalr.models.my_class` (import from\n    `azure.mgmt.signalr.models` works like before)\n  - An operation class `MyClassOperations` from an `operations`\n    sub-module cannot be imported anymore using\n    `azure.mgmt.signalr.operations.my_class_operations` (import from\n    `azure.mgmt.signalr.operations` works like before)\n\nLast but not least, HTTP connection pooling is now enabled by default.\nYou should always use a client as a context manager, or call close(), or\nuse no more than one client per process.\n\n## 0.3.0 (2019-08-06)\n\n**Features**\n\n  - Model SignalRResource has a new parameter cors\n  - Model SignalRResource has a new parameter features\n  - Model SignalRCreateOrUpdateProperties has a new parameter cors\n  - Model SignalRCreateOrUpdateProperties has a new parameter feature\n\n## 0.2.0 (2019-05-21)\n\n  - Add restart operation\n\n## 0.1.1 (2018-09-04)\n\n**Features**\n\n  - Model SignalRKeys has a new parameter secondary_connection_string\n  - Model SignalRKeys has a new parameter primary_connection_string\n  - Model MetricSpecification has a new parameter dimensions\n  - Model SignalRResource has a new parameter version\n  - Added operation group UsagesOperations\n\n## 0.1.0 (2018-05-07)\n\n  - Initial Release\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure SignalR Client Library for Python",
    "version": "1.2.0",
    "project_urls": {
        "Homepage": "https://github.com/Azure/azure-sdk-for-python"
    },
    "split_keywords": [
        "azure",
        "azure sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ef8b20d3116a27cf2b56526a657af03f389182208f0f23df6acf8bfc05588e69",
                "md5": "a444ca2a9d835beb6c9aabff711fb2ee",
                "sha256": "60ca153831d293ada9697d18d5689f2521c55e460a6ef66b6b261740e8a1b6b6"
            },
            "downloads": -1,
            "filename": "azure_mgmt_signalr-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a444ca2a9d835beb6c9aabff711fb2ee",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 115015,
            "upload_time": "2023-03-20T05:46:55",
            "upload_time_iso_8601": "2023-03-20T05:46:55.150198Z",
            "url": "https://files.pythonhosted.org/packages/ef/8b/20d3116a27cf2b56526a657af03f389182208f0f23df6acf8bfc05588e69/azure_mgmt_signalr-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6328acbe742e49ca694467a3b86e740babbc3bf67204bba980f4d1ebf4d1be03",
                "md5": "1f11954dd18859d9bb381a251ba45cec",
                "sha256": "8db16156825b39ba6f71526bd95a14cd8e429926e527a38aed0de5d7b48045f8"
            },
            "downloads": -1,
            "filename": "azure-mgmt-signalr-1.2.0.zip",
            "has_sig": false,
            "md5_digest": "1f11954dd18859d9bb381a251ba45cec",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 128094,
            "upload_time": "2023-03-20T05:46:57",
            "upload_time_iso_8601": "2023-03-20T05:46:57.664028Z",
            "url": "https://files.pythonhosted.org/packages/63/28/acbe742e49ca694467a3b86e740babbc3bf67204bba980f4d1ebf4d1be03/azure-mgmt-signalr-1.2.0.zip",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-20 05:46:57",
    "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-signalr"
}