azure-mgmt-digitaltwins


Nameazure-mgmt-digitaltwins JSON
Version 7.0.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-sdk-for-python
SummaryMicrosoft Azure Digital Twins Management Client Library for Python
upload_time2024-10-30 09:13:10
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 Digital Twins 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-digitaltwins
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.digitaltwins import AzureDigitalTwinsManagementClient
import os

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

## Examples

Code samples for this package can be found at:
- [Search Digital Twins 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

## 7.0.0 (2024-10-30)

### Breaking Changes

  - This package now only targets the latest Api-Version available on Azure and removes APIs of other Api-Version. After this change, the package can have much smaller size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ingore this change.

## 6.4.0 (2023-03-20)

### Features Added

  - Model AzureDataExplorerConnectionProperties has a new parameter adx_relationship_lifecycle_events_table_name
  - Model AzureDataExplorerConnectionProperties has a new parameter adx_twin_lifecycle_events_table_name
  - Model AzureDataExplorerConnectionProperties has a new parameter record_property_and_item_removals
  - Operation TimeSeriesDatabaseConnectionsOperations.begin_delete has a new optional parameter cleanup_connection_artifacts

## 6.4.0b1 (2023-02-16)

### Other Changes

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

## 6.3.0 (2022-12-15)

### Features Added

  - Model AzureDataExplorerConnectionProperties has a new parameter identity
  - Model DigitalTwinsEndpointResourceProperties has a new parameter identity
  - Model DigitalTwinsIdentity has a new parameter user_assigned_identities
  - Model EventGrid has a new parameter identity
  - Model EventHub has a new parameter identity
  - Model ServiceBus has a new parameter identity
  - Model TimeSeriesDatabaseConnectionProperties has a new parameter identity

## 6.2.0 (2022-06-28)

**Features**

  - Model DigitalTwinsEndpointResourceProperties.provisioning_state has a new state `Updating`

## 6.1.0 (2022-03-21)

**Features**

  - Added operation group TimeSeriesDatabaseConnectionsOperations
  - Model DigitalTwinsDescription has a new parameter system_data
  - Model DigitalTwinsEndpointResource has a new parameter system_data
  - Model DigitalTwinsResource has a new parameter system_data
  - Model ExternalResource has a new parameter system_data
  - Model Operation has a new parameter properties
  - Model PrivateEndpointConnection has a new parameter system_data

## 6.0.0 (2021-05-18)

- GA release

## 6.0.0b2 (2021-02-26)
* Fix version problem.

## 6.0.0b1 (2021-01-07)

This is beta preview version.
For detailed changelog please refer to equivalent stable version 1.0.0(https://pypi.org/project/azure-mgmt-digitaltwins/1.0.0/)

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.0 (2020-09-24)

* Release as Multi-API package.

## 0.1.0 (2020-05-31)

* Initial Release

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-mgmt-digitaltwins",
    "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/2e/2a/3f22fa82fa7f2698694a400deb1b0877a237aee1383df3940454e440d988/azure_mgmt_digitaltwins-7.0.0.tar.gz",
    "platform": null,
    "description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Digital Twins 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-digitaltwins\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.digitaltwins import AzureDigitalTwinsManagementClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = AzureDigitalTwinsManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Digital Twins 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## 7.0.0 (2024-10-30)\n\n### Breaking Changes\n\n  - This package now only targets the latest Api-Version available on Azure and removes APIs of other Api-Version. After this change, the package can have much smaller size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ingore this change.\n\n## 6.4.0 (2023-03-20)\n\n### Features Added\n\n  - Model AzureDataExplorerConnectionProperties has a new parameter adx_relationship_lifecycle_events_table_name\n  - Model AzureDataExplorerConnectionProperties has a new parameter adx_twin_lifecycle_events_table_name\n  - Model AzureDataExplorerConnectionProperties has a new parameter record_property_and_item_removals\n  - Operation TimeSeriesDatabaseConnectionsOperations.begin_delete has a new optional parameter cleanup_connection_artifacts\n\n## 6.4.0b1 (2023-02-16)\n\n### Other Changes\n\n  - Added generated samples in github repo\n  - Drop support for python<3.7.0\n\n## 6.3.0 (2022-12-15)\n\n### Features Added\n\n  - Model AzureDataExplorerConnectionProperties has a new parameter identity\n  - Model DigitalTwinsEndpointResourceProperties has a new parameter identity\n  - Model DigitalTwinsIdentity has a new parameter user_assigned_identities\n  - Model EventGrid has a new parameter identity\n  - Model EventHub has a new parameter identity\n  - Model ServiceBus has a new parameter identity\n  - Model TimeSeriesDatabaseConnectionProperties has a new parameter identity\n\n## 6.2.0 (2022-06-28)\n\n**Features**\n\n  - Model DigitalTwinsEndpointResourceProperties.provisioning_state has a new state `Updating`\n\n## 6.1.0 (2022-03-21)\n\n**Features**\n\n  - Added operation group TimeSeriesDatabaseConnectionsOperations\n  - Model DigitalTwinsDescription has a new parameter system_data\n  - Model DigitalTwinsEndpointResource has a new parameter system_data\n  - Model DigitalTwinsResource has a new parameter system_data\n  - Model ExternalResource has a new parameter system_data\n  - Model Operation has a new parameter properties\n  - Model PrivateEndpointConnection has a new parameter system_data\n\n## 6.0.0 (2021-05-18)\n\n- GA release\n\n## 6.0.0b2 (2021-02-26)\n* Fix version problem.\n\n## 6.0.0b1 (2021-01-07)\n\nThis is beta preview version.\nFor detailed changelog please refer to equivalent stable version 1.0.0(https://pypi.org/project/azure-mgmt-digitaltwins/1.0.0/)\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 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## 1.0.0 (2020-09-24)\n\n* Release as Multi-API package.\n\n## 0.1.0 (2020-05-31)\n\n* Initial Release\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure Digital Twins Management Client Library for Python",
    "version": "7.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": "e3fdfc2da81ae7875f225bb5bcb9aa5abba603a46f9c8803d49c2ebd6eb50c5a",
                "md5": "87e9a60bf912c474511a8299f420ed56",
                "sha256": "ac503d7e1536726a5bba1085479ed67917a73942f85e82072d08bfba891f4b80"
            },
            "downloads": -1,
            "filename": "azure_mgmt_digitaltwins-7.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "87e9a60bf912c474511a8299f420ed56",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 89147,
            "upload_time": "2024-10-30T09:13:11",
            "upload_time_iso_8601": "2024-10-30T09:13:11.835977Z",
            "url": "https://files.pythonhosted.org/packages/e3/fd/fc2da81ae7875f225bb5bcb9aa5abba603a46f9c8803d49c2ebd6eb50c5a/azure_mgmt_digitaltwins-7.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2e2a3f22fa82fa7f2698694a400deb1b0877a237aee1383df3940454e440d988",
                "md5": "dff57971bd2f8c4378f3f6f2c7f62565",
                "sha256": "fcc770666b4801ff0c86f5524113dfcbdae7d9c069c190cff64420961b080776"
            },
            "downloads": -1,
            "filename": "azure_mgmt_digitaltwins-7.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "dff57971bd2f8c4378f3f6f2c7f62565",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 66766,
            "upload_time": "2024-10-30T09:13:10",
            "upload_time_iso_8601": "2024-10-30T09:13:10.115591Z",
            "url": "https://files.pythonhosted.org/packages/2e/2a/3f22fa82fa7f2698694a400deb1b0877a237aee1383df3940454e440d988/azure_mgmt_digitaltwins-7.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-30 09:13:10",
    "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-digitaltwins"
}
        
Elapsed time: 0.33864s